Skip to content

Commit bcb2324

Browse files
committed
[docs] Move roadmap to separate file
1 parent fc133dd commit bcb2324

File tree

2 files changed

+47
-48
lines changed

2 files changed

+47
-48
lines changed

README.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -26,65 +26,21 @@ It's a game that resembles old 8-bit/16-bit games. This usually means:
2626

2727
* Most API function names are similar and behave the same way.
2828
* Screen resolution is small, and the number of colors is limited. Although in Pi you can change the resolution and palette.
29-
* You have one small sprite sheet and a map.
29+
* You have one small sprite sheet.
3030

3131
### Why would I use it?
3232

3333
Because it's the easiest way to write a game in Go. IMHO ;)
3434

3535
### Is Pi ready to use?
3636

37-
Pi is under development. Only limited functionality is provided. API is not stable. See [roadmap](#roadmap) for details.
37+
Pi is under development. Only limited functionality is provided. API is not stable. See [roadmap](ROADMAP.md) for details.
3838

39-
### How to get started?
39+
## How to get started?
4040

4141
1. Install dependencies
42-
* Go 1.18+
42+
* [Go 1.18+](https://go.dev/dl/)
4343
* Pi is powered by [Ebitengine](https://ebiten.org/) which has its own dependencies. See [instructions](https://ebiten.org/documents/install.html) how to install them.
4444
2. Create a new game using provided [Github template](https://github.com/elgopher/pi-template).
4545

4646
See also [examples](examples) directory and [documentation](https://pkg.go.dev/github.com/elgopher/pi).
47-
48-
## Roadmap
49-
50-
* [x] Present game on the screen
51-
* [x] ability to change the resolution and palette
52-
* [x] sprite-sheet loader
53-
* [ ] more options: full screen, specifying tps and scale
54-
* [x] Game loop
55-
* [ ] Implement Graphics API
56-
* [x] drawing sprites and pixels with camera and clipping support
57-
* [x] add the ability to directly access pixels on the screen and sprite-sheet
58-
* [x] palette transparency
59-
* [x] palette swapping
60-
* [ ] printing text on the screen
61-
* [x] system font
62-
* [ ] custom font and additional features: escape characters, offsets
63-
* [ ] drawing shapes
64-
* [x] rectangles, lines, circles
65-
* [ ] fill patterns
66-
* [ ] stretching sprites
67-
* [ ] map API
68-
* [ ] math API
69-
* [x] Cos, Sin, Atan2
70-
* [ ] Min, Max, Mid
71-
* [x] Game controller support: gamepad and keyboard
72-
* [ ] Mouse support (dev mode)
73-
* [ ] Full keyboard support (dev mode)
74-
* [ ] Menu screen
75-
* [ ] Development console
76-
* [ ] stopping, resuming the game
77-
* [x] add a programmatic way to stop the game
78-
* [ ] resume the game using console command
79-
* [ ] scripting (running π functions)
80-
* [ ] screen inspector
81-
* [ ] sprite-sheet editor
82-
* [ ] map editor
83-
* [ ] sound editor
84-
* [ ] music editor
85-
* [ ] Documentation
86-
* [ ] Go docs
87-
* [ ] Examples
88-
* [ ] simple programs for beginners
89-
* [ ] interactive programs describing how functions work
90-
* [ ] simple working game

ROADMAP.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Roadmap
2+
3+
* [x] Present game on the screen
4+
* [x] ability to change the resolution and palette
5+
* [x] sprite-sheet loader
6+
* [ ] more options: full screen, specifying tps and scale
7+
* [x] Game loop
8+
* [ ] Implement Graphics API
9+
* [x] drawing sprites and pixels with camera and clipping support
10+
* [x] add the ability to directly access pixels on the screen and sprite-sheet
11+
* [x] palette transparency
12+
* [x] palette swapping
13+
* [ ] printing text on the screen
14+
* [x] system font
15+
* [ ] custom font and additional features: escape characters, offsets
16+
* [ ] drawing shapes
17+
* [x] rectangles, lines, circles
18+
* [ ] fill patterns
19+
* [ ] stretching sprites
20+
* [ ] map API
21+
* [ ] math API
22+
* [x] Cos, Sin, Atan2
23+
* [ ] Min, Max, Mid
24+
* [x] Game controller support: gamepad and keyboard
25+
* [ ] Mouse support (dev mode)
26+
* [ ] Full keyboard support (dev mode)
27+
* [ ] Menu screen
28+
* [ ] Development console
29+
* [ ] stopping, resuming the game
30+
* [x] add a programmatic way to stop the game
31+
* [ ] resume the game using console command
32+
* [ ] scripting (running π functions)
33+
* [ ] screen inspector
34+
* [ ] sprite-sheet editor
35+
* [ ] map editor
36+
* [ ] sound editor
37+
* [ ] music editor
38+
* [ ] Documentation
39+
* [ ] Go docs
40+
* [ ] Examples
41+
* [ ] simple programs for beginners
42+
* [ ] interactive programs describing how functions work
43+
* [ ] simple working game

0 commit comments

Comments
 (0)