Relintai/pandemonium_engine_easy_charts
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine_easy_charts.git synced 2024-12-25 13:57:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Create README.md

Browse Source
This commit is contained in:
fenix-hub 2020-05-14 02:01:23 +02:00 committed by GitHub
parent 66ab9c36e3
commit 6605f4cf1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md Normal file
View File

@ -0,0 +1,58 @@
[![version](https://img.shields.io/badge/plugin%20version-0.1.0-blue)](https://github.com/fenix-hub/godot-engine.easy-charts)
[![updates](https://img.shields.io/badge/plugin%20updates-on%20discord-purple)](https://discord.gg/JNrcucg)
[![paypal](https://img.shields.io/badge/donations-PayPal-cyan)](https://paypal.me/NSantilio?locale.x=it_IT)
Check my **[Discord](https://discord.gg/KnJGY9S)** to stay updated on this repository.
*(Recommended since the AssetLibrary is not automatically updated)*
# GitHub Integration
A complete GitHub integration for your Godot Editor! Manage your project without even opening your browser.
Author: *"Nicolo (fenix) Santilio"*
Version: *0.1.0*
Wiki: *[wip]*
Godot Version: *3.2stable*
## What is this?
*Easy Charts* is collection of Control, 2D and 3D nodes to plot charts.
This plugin was born from the personal necessity to plot some charts and tables for my university degree project.
Here's an example: ![]()
Charts are really useful when it comes to visually represent values in a powerful and more understandable way, mostly when these charts also have visually pleasing features.
If you need to plot a chart with some values in it and just take a screenshot, or use it in your Godot Engine's game or project, you've come to the right place.
## How does it work?
*Easy Charts* contains a collection of nodes for each main node in Godot: Control Nodes, 2D Nodes and 3D Spatials.
To plot a chart you only need to:
1. Save in your project a .CSV file containing the table of values you want to represent, just like the following one:
![example1](imgs/EXCEL_mWtvuI90D0.png)
or, of course, the inverted one:
![example2](imgs/EXCEL_Fa2iiie9qC.png)
2. In Godot, choose a Chart you'd like to plot. For istance, let's take a BarChart2D, specifically used to plot chart in a Node2D. You can instance it as a Child Scene or drag it from the Explorer:
![example3](imgs/scene1.png)
![example4](imgs/scene2.png)
3. Once in the tree, move it around as a normal Node, and set it's values directly in editor, like so:
![example5](imgs/editor_gif.gif)
You can directly select the file you want to plot from the editor, and change its values as you prefer. Most of the features will be displayed in real time in Editor while you are editing them.
4. With just one line of code, you will be able to plot the chart. Use the line of code `$BarChart2D.plot()` to plot the chart with the properties edited in the editor.
![code1](imgs/code.png)
Running the project like this, will produce this chart:
![example6](imgs/chart_gif.gif)
5. Moving the cursor around you will be able to see a floating box with the values contained in the chart:
![example7](imgs/values.gif)
# Disclaimer
This addon was built for a **personal use** intention. It was released as an open source plugin in the hope that it could be useful to the Godot Engine Community.
As a "work in progress" project, there is *no warranty* for any eventual issue and bug that may broke your project.
I don't assume any responsibility for possible corruptions of your project. It is always advisable to keep a copy of your project and check any changes you make in your Github repository.
-----------------
> This text file was created via [TextEditor Integration](https://github.com/fenix-hub/godot-engine.text-editor) inside Godot Engine's Editor.