uxn/README.md

95 lines
1.6 KiB
Markdown
Raw Normal View History

2021-01-29 14:17:59 -05:00
# Uxn
A stack-based VM, written in ANSI C.
## Build
```
cc uxn.c -std=c89 -Os -DNDEBUG -g0 -s -Wall -Wno-unknown-pragmas -o uxn
```
2021-01-29 14:35:59 -05:00
2021-01-29 20:49:10 -05:00
## Assembly Syntax
2021-01-29 14:35:59 -05:00
2021-02-04 15:22:08 -05:00
### Write
2021-02-05 13:51:45 -05:00
- `;variable`, set a label to an assigned address
- `:const`, set a label to a constant short
- `@label`, set a label to an address
2021-02-04 15:22:08 -05:00
### Read
2021-02-05 13:51:45 -05:00
- `,literal`, push label value to stack
- `.pointer`, read label value
2021-02-04 15:22:08 -05:00
### Special
2021-02-05 13:51:45 -05:00
- `( comment )`, toggle parsing on/off
- `|0010`, move to position in the program
2021-02-05 14:57:37 -05:00
- `"hello`, push literal bytes for word "hello"
2021-01-31 00:31:49 -05:00
2021-02-06 13:39:13 -05:00
### Operator modes
- `,1234 ,0001 ADD^`, 16-bits operators have the short flag `^`.
2021-01-29 14:35:59 -05:00
```
2021-02-05 17:01:34 -05:00
( hello world )
2021-02-04 15:22:08 -05:00
2021-02-05 17:01:34 -05:00
;iterator
:dev1r FFF0
:dev1w FFF1
2021-01-29 20:49:10 -05:00
2021-02-05 17:01:34 -05:00
|0100 @RESET
2021-01-30 17:25:48 -05:00
2021-02-05 17:01:34 -05:00
"hello
@loop
,dev1w STR
2021-02-05 23:18:30 -05:00
,incr JSU ( call incr )
2021-02-05 17:01:34 -05:00
,05 NEQ ,loop ROT JSC
BRK ( RESET )
2021-02-05 23:18:30 -05:00
@incr
,iterator LDR
,01 ADD
,iterator STR
,iterator LDR
RTS
2021-02-05 17:01:34 -05:00
|c000 @FRAME BRK
|d000 @ERROR BRK
|FFFA .RESET .FRAME .ERROR
2021-01-29 14:35:59 -05:00
```
2021-02-01 14:58:47 -05:00
## Mission
2021-02-04 00:53:56 -05:00
### Assembler
2021-02-06 23:18:49 -05:00
- Complete implementing short mode
- Implement shorthand operators
2021-02-03 14:30:18 -05:00
- Catch overflow/underflow
- Jumps should be relative
2021-02-04 00:53:56 -05:00
### CPU
2021-02-03 14:30:18 -05:00
- Pointers/Literals
2021-02-01 17:49:09 -05:00
- A Three-Way Decision Routine(http://www.6502.org/tutorials/compare_instructions.html)
2021-02-01 14:58:47 -05:00
- Print word to stdout
- Draw pixel to screen
- Detect mouse click
2021-01-31 00:31:49 -05:00
- SDL Layer Emulator
- Build PPU
2021-02-04 18:38:04 -05:00
- Add flags..
2021-02-01 23:21:27 -05:00
2021-02-05 13:51:45 -05:00
### Devices
- Devices each have an input byte, an output byte and two request bytes.
2021-01-30 17:25:48 -05:00
## Refs
https://code.9front.org/hg/plan9front/file/a7f9946e238f/sys/src/games/nes/cpu.c
http://www.w3group.de/stable_glossar.html
http://www.emulator101.com/6502-addressing-modes.html
http://forth.works/8f0c04f616b6c34496eb2141785b4454
2021-02-05 23:18:30 -05:00
https://justinmeiners.github.io/lc3-vm/