SNES-IDE

Installation Guide

Requirements

• Operating System: Windows 10+ or Linux (with Wine 9.0+)
• Architecture: x64, x86_64, or amd64 (not ARM)
• Minimum Resources: 2 GB RAM, 200 MB disk space

Dependencies

• Windows: No dependencies required.
• Linux: Only Wine installed and configured is required.

Building from Source Dependencies

• Windows:Python 3.8+
• Linux: Wine, Bash, and Python 3.8 or newer

Windows Installation

1. Download the latest release from GitHub Releases.
2. Decompress the .zip to a folder of your choice.
3. Double-click INSTALL.bat to set up SNES-IDE and create shortcuts on your Desktop.

Linux Installation

1. Download the .deb package from the latest release: GitHub Releases.
2. Install Wine: sudo apt install wine
3. Install package:

   sudo apt install snes-ide_xyz.deb

4. Run using snes-ide command in terminal

Shortcuts Generated

• text-editor – Notepad++
• audio-tools – Convert and manage SNES-compatible audio assets
• graphic-tools – Convert and manage SNES-compatible graphics
• other-tools – Access additional utilities
• create-new-project – Scaffold a new project from a template
• compiler – Compile your project into a SNES ROM
• emulator – Launch your ROM in bsnes
• snes-ide – All-in-one shortcut, the main entry of SNES-IDE

Note: Shortcuts are created in Desktop/snes-ide/ on Windows, and as a command in /usr/local/bin in linux.

Getting Started

1. Create a new project using the create-new-project shortcut or batch file.
2. Edit your code in Notepad++ or your preferred editor.
3. Add assets using audio-tools and graphic-tools.
4. Compile your project with the compiler shortcut.
5. Test your ROM in an emulator using the emulator shortcut.
6. Or use snes-ide for an all-in-one experience.

Shortcuts Generated

• text-editor – Notepad++ or your preferred editor
• audio-tools – Convert and manage SNES-compatible audio assets
• graphic-tools – Convert and manage SNES-compatible graphics
• other-tools – Access additional utilities
• create-new-project – Scaffold a new project from a template
• compiler – Compile your project into a SNES ROM
• emulator – Launch your ROM in bsnes
• snes-ide – All-in-one shortcut, main entry of SNES-IDE

Project Structure

SNES-IDE/
├── libs/
│   └── notepad++/
├── tools/
│   ├── audio-tools.exe
│   ├── gfx-tools.exe
│   ├── externTools.exe
│   ├── create-new-project.exe
│   └── ...
├── snes-ide.exe
├── INSTALL.bat
├── ...
            

Shortcuts are created in Desktop/snes-ide/ on Windows, or as a desktop entry on Linux. Source code and assets are managed in your project folder.

Building from Source

1. Clone the repo: git clone https://github.com/BrunoRNS/SNES-IDE.git
2. Install dependencies:
   • Windows: Python 3.8+
   • Linux: Wine, Bash, Python 3.8+
3. Follow the build instructions in the docs.
4. After building, run the installer as described in the Installation Guide.

Frequently Asked Questions

• Can I use my own editor? Yes! Notepad++ is provided, but you can use any editor.
• Does it work on Mac? Not officially, but you may try using Wine or a VM.
• Where are my ROMs? Compiled ROMs are usually in your project folder or a Roms/ subdirectory.
• How do I add new tools? Place them in the tools/ directory. They must be a Python or .NET tool.
• How do I reinstall? Delete the .installed file and rerun setup.sh.
• How do I troubleshoot? Check terminal output for errors, ensure dependencies are installed, and see the Troubleshooting section in the docs.

Contributing

• Read Code of Conduct and Pull Request Guidelines.
• Fork the repo and create a feature branch.
• Write clear, modular code with comments.
• Add or update tests as needed.
• Submit a pull request with a descriptive title and summary.
• Open issues or discussions for bugs, ideas, or questions.

About & Credits

SNES-IDE is released under the GNU GPL v3 license.
Any game you create with this engine is entirely yours.
This IDE is not affiliated with, nor authorized, endorsed or licensed by Nintendo Corporation or its subsidiaries.

Special Thanks

• @Alekmaul and the pvsneslib team
• All bsnes team
• Notepad++ team
• @angelo-wf for SnesJs
• schismtracker team
• @nesdoug for M8TE
• @AlekIII for web-wav-converter
• @luizomf for programming mentorship
• Family, friends, and everyone who contributed in any way!

Contact

• GitHub: BrunoRNS/SNES-IDE
• Issues & Discussions: Use the GitHub repository to report bugs or ask questions.