Skip to content

Commit

Permalink
updated structure, Linux info added
Browse files Browse the repository at this point in the history
  • Loading branch information
@0x8BitDev
0x8BitDev committed May 17, 2019
1 parent 88ebc76 commit 2f8aade
Showing 1 changed file with 83 additions and 39 deletions.
122 changes: 83 additions & 39 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ Hi retro game developers!
Here you can find NES development tools:


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


**SharpDevelop solution:**
`.\src\MAPeD\MAPeD(NES).sln`

**NES assembly sources of tilemap renderers:**

`.\samples\nes\tilemap_render\bidir_scroll_MMC1\` - bidirectional scroller with dynamic mirroring and CHR bank switching
`.\samples\nes\tilemap_render\multidir_scroll_MMC3\` - multidirectional scroller
`.\samples\nes\tilemap_render\static_screens_MMC5\` - static screens switching with MMC5 extended attributes support

**ZX Spectrum sample sources:**
`.\samples\zx\tilemap_render\`


### SPReD(NES) - Sprites editor
---
# SPReD-NES - Sprites editor
**Some features are:**

- handy drawing mode
- group operations on sprites
- sprites data packing ( 1/2/4 KB ) and optimization
- 8x16 mode support
- images import\export
- export to CA65\NESasm
- export to **CA65\NESasm**
- etc...


**SharpDevelop solution:**
`.\src\SPReD\SPReD(NES).sln`
# Compiling
The solution files you can find here:
`.\src\MAPeD\MAPeD-NES.sln`
`.\src\SPReD\SPReD-NES.sln`

**Note:** **.Net 4.5.1** profile is required to build the tools.

## Windows
The tools were developed using **SharpDevelop 4.4.2.**
You can download it at: http://www.icsharpcode.net/OpenSource/SD/Download/Default.aspx

1) Run SharpDevelop.
2) Open solution file.
3) Menu: `Build -> Build Solution`.
4) `./bin` will contains output executable file.

## Linux
The tools were tested on **Ubuntu 16.4.6** and **Debian 9.9.0** with **Mono v5.20.1.19**.

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/

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/

1) Run MonoDevelop.
2) Open solution file.
3) Menu: `Build -> Build All`.
4) `./bin` will contains output executable file.

**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.


# Releases
## Windows
**.Net 4.5.1** is required to run the applications.
https://www.microsoft.com/en-us/download/details.aspx?id=40779

## Linux
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`.


# Samples
## MAPeD-NES
**NES assembly sources of tilemap renderers:**

`.\samples\nes\tilemap_render\bidir_scroll_MMC1\` - bidirectional scroller with dynamic mirroring and CHR bank switching
`.\samples\nes\tilemap_render\multidir_scroll_MMC3\` - multidirectional scroller
`.\samples\nes\tilemap_render\static_screens_MMC5\` - static screens switching with MMC5 extended attributes support

**ZX Spectrum sample sources ( can be compiled on Windows only ):**
`.\samples\zx\tilemap_render\`

## SPReD-NES
**NES assembly sources of simple character controllers:**

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


### Third-party libraries:
---
The SPReD(NES) uses the third-party library `.\src\SPReD\lib\Pngcs.dll` to read\write PNG images.
Developed by Hernan J Gonzalez Copyright 2012 ( Apache License, Version 2.0 )
The NES samples were created using **CA65 assembler (v2.17 - GIT 7445550)**.
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

https://github.com/leonbloy/pngcs
**CC65** installing instruction: http://wiki.nesdev.com/w/index.php/Installing_CC65

The ZX Spectrum sample uses **SjASMPlus - Z80 Assembly Cross-Compiler (v1.07 RC7)**.
The latest version can be downloaded at: https://sourceforge.net/projects/sjasmplus/

To compile the NES samples on Windows you can run 'compile.bat' which contains in all samples directories.

To compile them on Linux you can run 'makefile' which also contains in all samples directories.

- `make` to compile binaries to the `./samples/nes/bin` directory;
- `make run` to run compiled sample with **FCEUX** emulator;
- `make clean` to remove compiled binaries form the `./samples/nes/bin` directory;

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

---


# Third-party libraries

The SPReD(NES) uses the third-party library `.\src\SPReD\lib\Pngcs.dll` to read PNG images.
Developed by Hernan J Gonzalez Copyright 2012 ( Apache License, Version 2.0 )

https://github.com/leonbloy/pngcs

---
The tools sources:
https://github.com/0x8BitDev/MAPeD-SPReD
Expand All @@ -85,18 +138,9 @@ https://github.com/0x8BitDev/MAPeD-SPReD/releases

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

The tools were developed using **SharpDevelop 4.4.2.**
You can download it at: http://www.icsharpcode.net/OpenSource/SD/Download/Default.aspx

The NES samples were created using **CA65 assembler (v2.17 - GIT 7445550)**.
You can download the latest CC65 snapshots at: https://sourceforge.net/projects/cc65/files/cc65-snapshot-win32.zip/download

The ZX Spectrum sample uses **SjASMPlus - Z80 Assembly Cross-Compiler (v1.07 RC7)**.
The latest version can be downloaded at: https://sourceforge.net/projects/sjasmplus/

---
Developed by 0x8BitDev Copyright © 2017-2019
Developed by 0x8BitDev Copyright © 2017-2019

Released under the MIT license. See LICENSE.txt

mail: 0x8bitdev[at]gmail.com
mail: 0x8bitdev[at]gmail.com

0 comments on commit 2f8aade

Please sign in to comment.