Skip to content

Commit 77f83d8

Browse files
committed
[Readme] Updated readme instructions
1 parent 2f80728 commit 77f83d8

File tree

3 files changed

+86
-6
lines changed

3 files changed

+86
-6
lines changed

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,17 +98,38 @@ To begin using the Untold Engine, you’ll need:
9898
- An Apple computer.
9999
- The latest version of Xcode, which you can download from the App Store.
100100

101-
### Installation
102-
Follow the step-by-step guide to [clone and install the Untold Engine](docs/Installation.md)
101+
### Quick Start
102+
103+
Get the Untold Engine running in under a minute:
104+
105+
```bash
106+
git clone https://github.com/untoldengine/UntoldEngine.git
107+
cd UntoldEngine
108+
open Package.swift
109+
```
110+
111+
- In Xcode, select the DemoGame scheme.
112+
- Choose My Mac as the target.
113+
- Press Run ▶ and the Editor will launch.
114+
115+
🎮 You’re ready to explore!
116+
117+
👉 For full installation details (screenshots, controls, and Editor workflow), see the [Installation Guides](docs/Installation.md)
103118

104119
### Assets Download
105120
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.
106121

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.
109125

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).
112133

113134
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.
114135
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.
166187

167188
- [Editor Overview](docs/editoroverview.md): Walkthrough of Scene Graph, Inspector, Gizmos, Materials, Lighting, Post-Processing, Asset Browser, and Console.
168189
- [How to Import Assets](docs/importingassetseditor.md): Learn how to set asset paths and import models, materials, and animations.
190+
191+
### How-To Guides
169192
- [Adding a model using the Editor](docs/addModelUsingEditor.md): Learn how to add a model using the editor
170193
- [Adding an animation using the Editor](docs/addAnimationUsingEditor.md): Learn how to link an animation to the model using the editor (Coming Soon)
171194

@@ -246,6 +269,16 @@ This project is licensed under the **LGPL v2.1**.
246269
- **Developing a Game**: You can use the Untold Engine to build your game without needing to open source your game’s code.
247270
- **Modifying the Engine**: If you make changes to the engine itself, those changes must be open-sourced under the LGPL v2.1.
248271

272+
### License in Plain Terms
273+
274+
| You want to… | Allowed? | Obligations |
275+
|----------------------------|----------|----------------------------------------------|
276+
| Build a game with Untold | ✅ Yes | No need to open source your game’s code |
277+
| Modify Untold internals | ✅ Yes | Must share modifications under LGPL v2.1 |
278+
| Distribute the engine | ✅ Yes | Keep the LGPL license intact |
279+
| Use for commercial projects| ✅ Yes | No royalties or fees |
280+
281+
249282
For more details, see the full license text [here](https://www.gnu.org/licenses/lgpl-2.1.html).
250283

251284
---

docs/ContributionGuidelines.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
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.
44

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”*
18+
- Bad: *“Added PhysicsSystem + fixed rendering bug + updated docs”*
19+
20+
---
21+
522
### Required Contributions for New System Support
623

724
When adding new features or systems to the Untold Engine, your PR must include the following:

docs/addAnimationsUsingEditor.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## How-To: Add Animations Using the Editor
2+
3+
Follow these steps to add an animation to an entity. If you prefer, is a step-by-step [video](https://vimeo.com/1117004242?share=copy#t=0).
4+
5+
1. **Select the Entity**
6+
In the **Inspector**, make sure the entity you want to animate is selected.
7+
8+
2. **Add the Animation Component**
9+
- Click on **Add Components** in the Inspector.
10+
- Choose **Animation Component**.
11+
12+
![add animation component](../images/add-animation-component.png)
13+
14+
3. **Open the Asset Browser**
15+
- In the Asset Browser, click on **Animations**.
16+
- Browse to the `.usdc` animation file you want to use.
17+
18+
![select animation file](../images/animation-running.png)
19+
20+
4. **Select the Animation File**
21+
- Click on the animation file in the Asset Browser.
22+
23+
5. **Assign the Animation**
24+
- In the Inspector, under the **Animation Component**, click on **Assign**.
25+
- The animation’s name should now appear in the component field.
26+
27+
![Animation selected](../images/animation-assign.png)
28+
29+
🎬 Your entity is now linked to the animation!
30+

0 commit comments

Comments
 (0)