https://github.com/mrchantey/koora

Assemblyscript 3D Game Framework
https://github.com/mrchantey/koora

Last synced: 3 months ago
JSON representation

Assemblyscript 3D Game Framework

• Host: GitHub
• URL: https://github.com/mrchantey/koora
• Owner: mrchantey
• License: mit
• Archived: true
• Created: 2022-04-11T01:13:38.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-03T03:45:34.000Z (over 2 years ago)
• Last Synced: 2024-11-14T02:37:37.785Z (3 months ago)
• Language: TypeScript
• Size: 2.11 MB
• Stars: 27
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-assemblyscript - mrchantey/Koora - 3D game framework (Packages)

README

        
# koora

> **NOTE: This project is not in active development.**

> 

> I'm continuing my wasm experiments using [Rust and Bevy](https://bevyengine.org/)

AssemblyScript Game Framework

website: [koora.dev](https://koora.dev)

## Packages

- `./packages/ecs`

  - No-Dependency ECS Architecture

- `./packages/core`

  - Koora Core

  - WebGL

- `./packages/site`

  - Documentation

  - Blog

  - Examples

## Repo Guide

There are quite a few steps to getting up and running, but the end result is hot reloading across both wasm and web.

### Up and running - Core

To get up and running:

1. Terminal 1: `npm run watch-as -w packages/core`

   - This watches the `src-as` directory for changes

2. Terminal 2: `npm run watch-src -w packages/core`

   - This starts webpack in watch mode, watching the `src` directory

4. Terminal 3: `npm run start -w packages/core`

   - This starts `live-server`, watching the build directory

5. Visit `http://127.0.0.1:8080/?ktest`

	- The query parameter just starts some debug stuff to check all is working

### Up and running - Site

To get site up and running

1. Terminal 1: `npm run watch-build -w packages/core`

	- this will update the sites build whenever the core build changes

2. Terminal 2: `npm run start -w packages/site`

	- start docusaurus

### Up and running - Testing

To test ecs proxy generator:

1. `npm run make-proxies-test -w packages/ecs`

Unit tests

1. `npm run test -w packages/testing`

## TODO

- Material UBOs

- Sparse Set ECS

- SDF fonts

- Simple collision