Skip to content

Commit 2f8aade

Browse files
0x8BitDev0x8BitDev
committed
updated structure, Linux info added
1 parent 88ebc76 commit 2f8aade

File tree

1 file changed

+83
-39
lines changed

1 file changed

+83
-39
lines changed

‎README.md

+83-39
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ Hi retro game developers!
33
Here you can find NES development tools:
44

55

6-
### MAPeD(NES) - Game maps editor
7-
---
6+
# MAPeD-NES - Game maps editor
87
**The main features are:**
98
- tiles drawing\composing tools
109
- building a game map using 2x2 or\and 4x4 tiles
@@ -15,7 +14,7 @@ Here you can find NES development tools:
1514
- tile properties editing ( can be used as collisions data etc )
1615
- palette per 1x1 tile support ( MMC5 )
1716
- import tiles from images
18-
- export to CA65\NESasm with wide variety of options:
17+
- export to **CA65\NESasm** with wide variety of options:
1918
- 2x2\4x4 tiles
2019
- column\row data order
2120
- RLE compression
@@ -25,57 +24,111 @@ Here you can find NES development tools:
2524
- level topology options
2625
- entities
2726
- etc...
28-
- export to SjASMPlus ( ZX Spectrum assembler )
27+
- export to **SjASMPlus** ( ZX Spectrum assembler )
2928
- etc...
3029

3130

32-
**SharpDevelop solution:**
33-
`.\src\MAPeD\MAPeD(NES).sln`
34-
35-
**NES assembly sources of tilemap renderers:**
36-
37-
`.\samples\nes\tilemap_render\bidir_scroll_MMC1\` - bidirectional scroller with dynamic mirroring and CHR bank switching
38-
`.\samples\nes\tilemap_render\multidir_scroll_MMC3\` - multidirectional scroller
39-
`.\samples\nes\tilemap_render\static_screens_MMC5\` - static screens switching with MMC5 extended attributes support
40-
41-
**ZX Spectrum sample sources:**
42-
`.\samples\zx\tilemap_render\`
43-
44-
45-
### SPReD(NES) - Sprites editor
46-
---
31+
# SPReD-NES - Sprites editor
4732
**Some features are:**
4833

4934
- handy drawing mode
5035
- group operations on sprites
5136
- sprites data packing ( 1/2/4 KB ) and optimization
5237
- 8x16 mode support
5338
- images import\export
54-
- export to CA65\NESasm
39+
- export to **CA65\NESasm**
5540
- etc...
5641

5742

58-
**SharpDevelop solution:**
59-
`.\src\SPReD\SPReD(NES).sln`
43+
# Compiling
44+
The solution files you can find here:
45+
`.\src\MAPeD\MAPeD-NES.sln`
46+
`.\src\SPReD\SPReD-NES.sln`
47+
48+
**Note:** **.Net 4.5.1** profile is required to build the tools.
49+
50+
## Windows
51+
The tools were developed using **SharpDevelop 4.4.2.**
52+
You can download it at: http://www.icsharpcode.net/OpenSource/SD/Download/Default.aspx
53+
54+
1) Run SharpDevelop.
55+
2) Open solution file.
56+
3) Menu: `Build -> Build Solution`.
57+
4) `./bin` will contains output executable file.
58+
59+
## Linux
60+
The tools were tested on **Ubuntu 16.4.6** and **Debian 9.9.0** with **Mono v5.20.1.19**.
61+
62+
To compile/run the applications on Linux you need to install Mono on your computer. The latest stable release can be found here: https://www.mono-project.com/download/stable/
63+
64+
The Linux versions were tested using **MonoDevelop 7.8.2 (build 2)**. The latest stable release can be found here: https://www.monodevelop.com/download/
65+
66+
1) Run MonoDevelop.
67+
2) Open solution file.
68+
3) Menu: `Build -> Build All`.
69+
4) `./bin` will contains output executable file.
70+
71+
**Warning:** It's not necessary to rebuild the tools on Linux if you don't want to make any changes in sources. You can use the same executables files on Windows and Linux.
72+
73+
74+
# Releases
75+
## Windows
76+
**.Net 4.5.1** is required to run the applications.
77+
https://www.microsoft.com/en-us/download/details.aspx?id=40779
78+
79+
## Linux
80+
As mentioned before, you need to install Mono on your computer. To run the tools you may need to configure your environment to allow it to automatically run .exe files through Mono, or manually run the tools in terminal: `mono MAPeD-NES.exe`, `mono SPReD-NES.exe`.
81+
82+
83+
# Samples
84+
## MAPeD-NES
85+
**NES assembly sources of tilemap renderers:**
86+
87+
`.\samples\nes\tilemap_render\bidir_scroll_MMC1\` - bidirectional scroller with dynamic mirroring and CHR bank switching
88+
`.\samples\nes\tilemap_render\multidir_scroll_MMC3\` - multidirectional scroller
89+
`.\samples\nes\tilemap_render\static_screens_MMC5\` - static screens switching with MMC5 extended attributes support
90+
91+
**ZX Spectrum sample sources ( can be compiled on Windows only ):**
92+
`.\samples\zx\tilemap_render\`
6093

94+
## SPReD-NES
6195
**NES assembly sources of simple character controllers:**
6296

6397
`.\samples\nes\player_cntrl_NROM-128` - character controller: idle, running and jumping; 8x8\8x16 mode
6498
`.\samples\nes\player_cntrl_MMC3` - the same as above, but using big sprites with MMC3 1KB CHR bank switching
6599
( +shooting and ducking animations )
66100

67-
68-
### Third-party libraries:
69101
---
70-
The SPReD(NES) uses the third-party library `.\src\SPReD\lib\Pngcs.dll` to read\write PNG images.
71-
Developed by Hernan J Gonzalez Copyright 2012 ( Apache License, Version 2.0 )
102+
The NES samples were created using **CA65 assembler (v2.17 - GIT 7445550)**.
103+
Github page: https://github.com/cc65/cc65 Or you can download the latest CC65 snapshots at: https://sourceforge.net/projects/cc65/files/cc65-snapshot-win32.zip
72104

73-
https://github.com/leonbloy/pngcs
105+
**CC65** installing instruction: http://wiki.nesdev.com/w/index.php/Installing_CC65
106+
107+
The ZX Spectrum sample uses **SjASMPlus - Z80 Assembly Cross-Compiler (v1.07 RC7)**.
108+
The latest version can be downloaded at: https://sourceforge.net/projects/sjasmplus/
109+
110+
To compile the NES samples on Windows you can run 'compile.bat' which contains in all samples directories.
111+
112+
To compile them on Linux you can run 'makefile' which also contains in all samples directories.
113+
114+
- `make` to compile binaries to the `./samples/nes/bin` directory;
115+
- `make run` to run compiled sample with **FCEUX** emulator;
116+
- `make clean` to remove compiled binaries form the `./samples/nes/bin` directory;
74117

75118
---
76-
**WARNING:** The sample codes coming with the tools were made just for testing of exported data.
119+
**Warning:** The sample codes coming with the tools were made just for testing of exported data.
77120
You can use\modify them for free at your own risk without any warranties.
78121

122+
---
123+
124+
125+
# Third-party libraries
126+
127+
The SPReD(NES) uses the third-party library `.\src\SPReD\lib\Pngcs.dll` to read PNG images.
128+
Developed by Hernan J Gonzalez Copyright 2012 ( Apache License, Version 2.0 )
129+
130+
https://github.com/leonbloy/pngcs
131+
79132
---
80133
The tools sources:
81134
https://github.com/0x8BitDev/MAPeD-SPReD
@@ -85,18 +138,9 @@ https://github.com/0x8BitDev/MAPeD-SPReD/releases
85138

86139
The latest development build can be found **[here](https://drive.google.com/open?id=1Jopms8ENPrjTktrt_V36TQC2FZT2agId)**.
87140

88-
The tools were developed using **SharpDevelop 4.4.2.**
89-
You can download it at: http://www.icsharpcode.net/OpenSource/SD/Download/Default.aspx
90-
91-
The NES samples were created using **CA65 assembler (v2.17 - GIT 7445550)**.
92-
You can download the latest CC65 snapshots at: https://sourceforge.net/projects/cc65/files/cc65-snapshot-win32.zip/download
93-
94-
The ZX Spectrum sample uses **SjASMPlus - Z80 Assembly Cross-Compiler (v1.07 RC7)**.
95-
The latest version can be downloaded at: https://sourceforge.net/projects/sjasmplus/
96-
97141
---
98-
Developed by 0x8BitDev Copyright © 2017-2019
142+
Developed by 0x8BitDev Copyright © 2017-2019
99143

100144
Released under the MIT license. See LICENSE.txt
101145

102-
mail: 0x8bitdev[at]gmail.com
146+
mail: 0x8bitdev[at]gmail.com

0 commit comments

Comments
 (0)