Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moroboxai/moroxel8ai
Fantasy 8-bit CPU for MoroboxAI
https://github.com/moroboxai/moroxel8ai
8-bit 8-bit-cpu cpu fantasy-console javascript lua moroboxai pixijs typescript
Last synced: 5 days ago
JSON representation
Fantasy 8-bit CPU for MoroboxAI
- Host: GitHub
- URL: https://github.com/moroboxai/moroxel8ai
- Owner: moroboxai
- License: mit
- Created: 2022-06-18T07:29:59.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T16:57:45.000Z (over 1 year ago)
- Last Synced: 2024-11-03T17:08:39.020Z (3 months ago)
- Topics: 8-bit, 8-bit-cpu, cpu, fantasy-console, javascript, lua, moroboxai, pixijs, typescript
- Language: TypeScript
- Homepage:
- Size: 4.95 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# moroxel8ai
[](https://www.npmjs.com/package/moroxel8ai)
[](https://github.com/moroboxai/moroxel8ai/blob/master/LICENSE)
[](https://lgtm.com/projects/g/moroboxai/moroxel8ai/context:javascript)
[](https://lgtm.com/projects/g/moroboxai/moroxel8ai/alerts)
Fantasy 8-bit CPU for [MoroboxAI](https://github.com/moroboxai).
## Why
MoroboxAI by itself is a generic framework that can run any JavaScript code that exports a **boot** function.
Moroxel8AI is a layer of abstraction on top of that and:
* Uses [PixiJS](https://pixijs.com/) as a renderer
* Uses [fengari](https://github.com/fengari-lua/fengari) for running your game written in Lua
* Implements all the boilerplate for being compatible with MoroboxAI
* Takes care of loading all your assets
* Provides a simple interface for controlling the graphics, audio, and inputs
To sum up, Moroxel8AI takes care of all the boilerplate required for initializing and running your game in MoroboxAI, and lets you focus on coding the game logic in Lua.
## Minimal game
For the purpose of this tutorial, we will create a `sample` folder with the following structure:
```bash
sample/
├─ assets/
│ ├─ tilemap.png
├─ game.lua
├─ header.yml
├─ index.html
```
The `assets` directory is where Moroxel8AI will load assets from. Here is `tilemap.png`, this is a 16x16 pixels tilemap taken from Mario on NES:
The `header.json` contains some metadata about assets and how to run the game:
```yml
assets:
- name: tilemap
path: tilemap.png
boot: Moroxel8AI
main: game.lua
```
All the game logic is written in `game.lua`:
```lua
-- select tilemap.png as the tilemap
local tilemap = tmap('tilemap')
-- set the size of one tile to 16x16 pixels
tmode(16)
-- assign the tile (0, 3) to sprite
stile(tilemap, 0, 3, 1, 1)
-- set the origin to center
sorigin(8, 8)
local angle = 0
function tick(deltaTime)
-- clear screen
clear()
-- rotate sprite
angle = angle + deltaTime
srot(angle)
-- draw sprite on screen
sdraw(SWIDTH / 2, SHEIGHT / 2)
end
```
Now, all remain is `index.html` which is simply loading MoroboxAI + Moroxel8AI and initializing the game:
```html
moroxel8ai
(function() {
console.log(`moroboxai-player-web v${MoroboxAIPlayer.VERSION}`);
player = MoroboxAIPlayer.init(document.getElementById("player"), {
url: `./`,
resizable: false,
autoPlay: true,
onReady: () => console.log("ready")
});
})();
body {
height: 100%;
margin: 0;
padding: 0;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
}
#player {
background-color: black;
background-size: cover;
width: 256px;
height: 256px;
}
```
## Run on the web
Testing on the web requires you to run a local HTTP server to avoid CORS errors when loading local files.
For that you can install **http-server**:
```bash
npm install http-server -g
```
Open a command prompt in the `moroxel8ai` folder and run:
```bash
http-server
```
Now you can access the page on **localhost** and the port opened by **http-server**.
## License
This content is released under the [MIT](http://opensource.org/licenses/MIT) License.