Commit ee2e3c4a authored by Rahix's avatar Rahix 🦀
Browse files

Update README

parent 0405264e
# What is this?
This will at some point be a game, written in Rust, using WebAssembly.
# Hacking
- [Project Structure](#project-structure)
- [Build Dependencies](#build-dependencies)
- [Development Environment](#development-environment)
- [Project Structure](#project-structure)
## Project Structure
The project is mainly split into two parts: The game logic, written in Rust,
living in `src/`, and the web-frontend in `www/src/` which is mainly HTML and
SCSS + a bit of JS glue code.
#### `src/` - Rust Game Logic
- `src/main.rs`: Entry-point, world setup, and game loop
- `src/utils.rs`: Javascript-Gluecode, e.g. a `request_animation_frame()`
wrapper.
- `src/colliders.rs`: `ncollide2d` integration
- `src/components/`: Components and closely related systems
- `src/resources/`: Game-global resources like a global clock
#### `www/src/` - Web Frontend
- `www/src/index.html`: Main HTML Document
- `www/src/styles.scss`: Stylesheet using Sass
- `www/src/_rc3-*`: Styles and Fonts for RC3
## Build Dependencies
Not quite sure what the dependencies really are, please add
......@@ -38,9 +58,6 @@ Then point your browser to `http://localhost:8080` and start hacking! The
website will automatically reload when any changes are done to the web sources
(`www/src/`) or the Rust sources (`src/`).
## Project Structure
*TODO*
---
# License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment