NESkit

NESkit is development kit for Nintendo Entertainment System that designed with ease of use in mind, it has every tool you need to make your game from asset converters to a map editor, it also uses C as its programming language

-----------------------------------------------------

FAQ

Why did you create this?

i created this because i was generally interested in developing games for old consoles but didnt found any library who was easy to use and powerful at the same time, all libraries were either easy to use but limited or powerful but complex to use, but NESkit balances these two

What types of game can i make with this?

generally you can make any type of game you want with NESkit but library has more premade features for making platformers

What Libraries and Frameworks inspired you to make this?

we took inspiration from pico8 and raylib

Will this library becomes open source?

probably not for now since i spent a lot of time researching and i also bought a few technologies in order to make this library possible, at the future that this library becomes more mature i might release it as source available proprietary software but i wont make any promises

-----------------------------------------------------

Documentation

we have an API documentation that you can find on "docs" folder, currently our documentation is AI generated but we are working on creating a github wiki with code examples and tutorials for NESkit, we are also working on creating a youtube tutorial that teaches how to setup the library and compile games for nes

you can also check the "examples" folder to get started on how to create, load and use audio, sprites and maps with the development kit

-----------------------------------------------------

Project Directory

neskit/

├── compiler/    #cc65 compiler

├── docs/

│   ├── API.html    #API documentation

├── emulator/     #emulator used for testing games

├── examples/     #various examples that showcases how to use the development kit

├── lib/

│   ├── neskit.lib    #compiled lib file

├── licenses/    #licenses folder

├── src/

│   ├── neskit.c    #NESkit library

│   ├── neskit.h    #header file

├── tools/

│   ├── map_editor.py    #tile based map editor

│   ├── png2nes.py    # convert png files to NES usable formats

│   ├── wav2nes.py    # convert wav files to NES usable formats

-----------------------------------------------------

Tools

png2nes.py

this tool helps you convert png files to chr files to be used in NES, you can also export to a C header file

Note : in order for this tool to work you need to use and 8x8 dividable image, this is because of NES limitations who can only read sprites in 8x8 chunks

wav2nes.py

this tool converts your wav files into bin files that can be used in NES, it can also export to a C header file

map_editor.py

this is a tile based map editor that you can use to edit maps for your games. just load your png file and edit your maps, then in order to  use those maps in NESkit you can export them as C header

-----------------------------------------------------

License

you can generally use this library to create both commercial and non commercial games, but you cant resell the library, you cant also include library in a open source project unless the project only contains game logic and not the codes related to library

-----------------------------------------------------

if you need any help with the library or faced any issues you can always ask for help in comments sections

We also provide support on our discord server: https://discord.gg/vVpeXp7mJb

Logo Designed by Freepik