You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
👉 For full installation details (screenshots, controls, and Editor workflow), see the [Installation Guides](docs/Installation.md)
103
118
104
119
### Assets Download
105
120
To help you get started, download the [Demo Game Assets v1.0](https://github.com/untoldengine/UntoldEngine-Assets/releases/tag/v1). It contains models and animations that you can use as you try out the engine. Unzip the folder and place it on your Desktop.
106
121
107
-
### Demo Game - Jump right in
108
-
Want to see the Untold Engine in action with zero setup? The **Demo Game** is for you! It’s a simple, ready-to-run soccer dribbling game — perfect for testing the engine and getting a feel for how it works. Follow the step-by-step guide to run the [small demo](docs/demogamesteps.md)
122
+
### Demo Game – Jump right in
123
+
The **Demo Game** is a simple soccer dribbling example that runs out of the box.
124
+
It not only lets you test the engine with zero setup, but also serves as a live reference for how the API is used in practice — from entity creation to animations and physics.
109
125
110
-
### Starter Game - Experiment and Learn
111
-
If you want to tinker and get hands-on, the **Starter Game** is your playground. It’s a minimal setup that gives you just enough to start experimenting, importing assets, and building your own mechanics. Follow the step-by-step guide to run the [starter game](docs/startergamesteps.md)
126
+
👉 Follow the step-by-step guide to run the [small demo](docs/demogamesteps.md).
127
+
128
+
### Starter Game – Experiment and Learn
129
+
The **Starter Game** is a minimal project designed as your playground.
130
+
It gives you a clean slate to experiment with importing assets, writing your own systems, and building new mechanics. Unlike the Demo Game (which shows the API in action), the Starter Game is where you can start creating your own gameplay ideas.
131
+
132
+
👉 Follow the step-by-step guide to run the [starter game](docs/startergamesteps.md).
112
133
113
134
For an overview of how to reference entities, play animations, and create components and systems, check out the files in the DemoGame folder. More documentation is on the way, but these examples should be enough to help you get started.
114
135
If you run into any issues or have questions, please don’t hesitate to open an [issue](https://github.com/untoldengine/UntoldEngine/issues).
@@ -166,6 +187,8 @@ The Untold Engine is powered by modular systems that simplify game development.
166
187
167
188
-[Editor Overview](docs/editoroverview.md): Walkthrough of Scene Graph, Inspector, Gizmos, Materials, Lighting, Post-Processing, Asset Browser, and Console.
168
189
-[How to Import Assets](docs/importingassetseditor.md): Learn how to set asset paths and import models, materials, and animations.
190
+
191
+
### How-To Guides
169
192
-[Adding a model using the Editor](docs/addModelUsingEditor.md): Learn how to add a model using the editor
170
193
-[Adding an animation using the Editor](docs/addAnimationUsingEditor.md): Learn how to link an animation to the model using the editor (Coming Soon)
171
194
@@ -246,6 +269,16 @@ This project is licensed under the **LGPL v2.1**.
246
269
-**Developing a Game**: You can use the Untold Engine to build your game without needing to open source your game’s code.
247
270
-**Modifying the Engine**: If you make changes to the engine itself, those changes must be open-sourced under the LGPL v2.1.
Copy file name to clipboardExpand all lines: docs/ContributionGuidelines.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,23 @@
2
2
3
3
I'm excited to have you contribute to the Untold Engine! To maintain consistency and quality, please follow these guidelines when submitting a pull request (PR). Submissions that do not adhere to these guidelines will not be approved.
4
4
5
+
### Pull Request Guidelines
6
+
7
+
-**One feature or bug fix per PR**
8
+
Each Pull Request should focus on a single feature, bug fix, or documentation improvement.
9
+
This keeps the history clean and makes it easier to track down issues later.
10
+
11
+
-**Commit hygiene**
12
+
- Keep commits meaningful (avoid "misc changes" or "fix stuff").
13
+
- Squash commits if needed, but do not mix unrelated features in the same commit.
14
+
- If your PR touches multiple files, make sure they all relate to the same feature or fix.
15
+
16
+
✅ Example:
17
+
- Good: *“Add PhysicsSystem with gravity integration”*
0 commit comments