mirror of
https://github.com/Insality/druid
synced 2025-09-27 18:12:21 +02:00
Update README and other docs
This commit is contained in:
@@ -37,7 +37,7 @@
|
||||
<li><a href="#Creating_components">Creating components </a></li>
|
||||
<li><a href="#Examples">Examples </a></li>
|
||||
<li><a href="#Documentation">Documentation </a></li>
|
||||
<li><a href="#Games_powered_by_Druid_">Games powered by Druid: </a></li>
|
||||
<li><a href="#Games_powered_by_Druid">Games powered by Druid </a></li>
|
||||
<li><a href="#Future_plans">Future plans </a></li>
|
||||
<li><a href="#License">License </a></li>
|
||||
<li><a href="#Issues_and_suggestions">Issues and suggestions </a></li>
|
||||
@@ -81,13 +81,16 @@
|
||||
|
||||
<div id="content">
|
||||
|
||||
<img src="druid_logo.png" alt=""/></p>
|
||||
<a href="https://insality.github.io/druid/"><img src="media/druid_logo.png" alt=""/></a></p>
|
||||
|
||||
<p><strong>Druid</strong> - powerful defold component UI library. Use basic druid components or make your own game-specific components to make amazing GUI in your games.</p>
|
||||
|
||||
|
||||
<p><a name="Setup"></a></p>
|
||||
<h2>Setup</h2>
|
||||
<h4>Dependency</h4>
|
||||
|
||||
<h3>Dependency</h3>
|
||||
|
||||
<p>You can use the druid extension in your own project by adding this project as a <a href="https://www.defold.com/manuals/libraries/">Defold library dependency</a>. Open your game.project file and in the dependencies field under project add:</p>
|
||||
|
||||
<blockquote>
|
||||
@@ -97,7 +100,8 @@
|
||||
<p>Or point to the ZIP file of a <a href="https://github.com/Insality/druid/releases">specific release</a>.</p>
|
||||
|
||||
|
||||
<h4>Code</h4>
|
||||
<h3>Code</h3>
|
||||
|
||||
<p>Adjust druid settings, if needed:</p>
|
||||
|
||||
<pre>
|
||||
@@ -114,8 +118,10 @@
|
||||
</pre>
|
||||
|
||||
|
||||
|
||||
<p><a name="Components"></a></p>
|
||||
<h2>Components</h2>
|
||||
|
||||
<p>Druid provides next basic components:
|
||||
- <strong>Button</strong> - Basic game button</p>
|
||||
|
||||
@@ -132,12 +138,16 @@
|
||||
<li><p><strong>Checkbox</strong> - Basic checkbox component</p></li>
|
||||
<li><p><strong>Checkbox group</strong> - Several checkboxes in one group</p></li>
|
||||
<li><p><strong>Radio group</strong> - Several checkboxes in one group with single choice</p></li>
|
||||
<li><p><strong>Hover</strong> - Trigger component for check node hover state</p></li>
|
||||
<li><p><strong>Input</strong> - Component to process user text input</p></li>
|
||||
</ul>
|
||||
|
||||
<p>Full info see on <em>components.md</em></p>
|
||||
|
||||
|
||||
<p><a name="Creating_components"></a></p>
|
||||
<h2>Creating components</h2>
|
||||
|
||||
<p>Any components creating via druid:</p>
|
||||
|
||||
<pre>
|
||||
@@ -163,14 +173,20 @@
|
||||
</pre>
|
||||
|
||||
|
||||
|
||||
<p><a name="Examples"></a></p>
|
||||
<h2>Examples</h2>
|
||||
<p>See the <a href="https://github.com/Insality/druid/tree/develop/example/kenney">example folder</a> for examples of how to use Druid
|
||||
See the <a href="https://github.com/Insality/druid-assets">druid-assets repository</a> for examples of how to create custom components and styles
|
||||
Try the HTML5 version of the example app</p>
|
||||
|
||||
<p>See the <a href="https://github.com/insality/druid/tree/develop/example/kenney">example folder</a> for examples of how to use Druid</p>
|
||||
|
||||
<p>See the <a href="https://github.com/insality/druid-assets">druid-assets repository</a> for examples of how to create custom components and styles</p>
|
||||
|
||||
<p>Try the HTML5 version of the example app</p>
|
||||
|
||||
|
||||
<p><a name="Documentation"></a></p>
|
||||
<h2>Documentation</h2>
|
||||
|
||||
<p>To learn druid better, read next documentation:
|
||||
- Druid components
|
||||
- Create custom components
|
||||
@@ -180,10 +196,13 @@ Try the HTML5 version of the example app</p>
|
||||
<p>Full druid documentation you can find here:
|
||||
https://insality.github.io/druid/</p>
|
||||
|
||||
<p><a name="Games_powered_by_Druid_"></a></p>
|
||||
<h2>Games powered by Druid:</h2>
|
||||
|
||||
<p><a name="Games_powered_by_Druid"></a></p>
|
||||
<h2>Games powered by Druid</h2>
|
||||
|
||||
<p><em>Will fill later</em></p>
|
||||
|
||||
|
||||
<p><a name="Future_plans"></a></p>
|
||||
<h2>Future plans</h2>
|
||||
|
||||
@@ -195,22 +214,27 @@ https://insality.github.io/druid/</p>
|
||||
<li><p>Add more comfortable gamepad support for GUI (ability to select button with DPAD and other stuff)</p></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<p><a name="License"></a></p>
|
||||
<h2>License</h2>
|
||||
<p>Original idea by <a href="https://github.com/AGulev">AGulev</a>
|
||||
Developed and supporting by <a href="https://github.com/Insality">Insality</a>
|
||||
MIT License</p>
|
||||
|
||||
<p>Original idea by <a href="https://github.com/AGulev">AGulev</a></p>
|
||||
|
||||
<p>Developed and supporting by <a href="https://github.com/Insality">Insality</a></p>
|
||||
|
||||
<p>MIT License</p>
|
||||
|
||||
|
||||
<p><a name="Issues_and_suggestions"></a></p>
|
||||
<h2>Issues and suggestions</h2>
|
||||
|
||||
<p>If you have any issues, questions or suggestions please <a href="https://github.com/Insality/druid/issues">create an issue</a> or contact me: <a href="mailto:insality@gmail.com">insality@gmail.com</a>
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2020-03-21 22:53:41 </i>
|
||||
<i style="float:right;">Last updated 2020-03-21 22:59:46 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
Reference in New Issue
Block a user