Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 2.96 KB

README.md

File metadata and controls

53 lines (42 loc) · 2.96 KB
Raw

SnesXM

A Super NES emulator in C#

This project is nowhere near done.

Table of Contents

What is SnesXM?

SnesXM will be my attempt to write a super NES emulator in C#. The need has arisen following a lot of work in MushROMs.

Installation

Presently, the Visual Studio 2017 IDE is the only supported environment for SnesXM. Users are encouraged to suggest new environments in our Issues section.

Visual Studio

  • Get the latest version of Visual Studio. At the time of writing this, it should be Visual Studio 2017. You have three options: Community, Professional, and Enterprise. Any of these three are fine. The collaborators presently build against community since it is free. See that you meet the System Requirements for Visual Studio for best interaction.
  • When installing Visual Studio (or if you've already installed but missed these components, go to the installer),
    • Under the Workloads tab, select .NET desktop development
    • Under the Individual Components tab, select .NET Framework 4.7 SDK and .NET Framework 4.7 targeting pack if they weren't already selected.
    • Under the Code Tools section (still in Individual Components tab), select Git for Windows and GitHub extension for Visual Studio.
  • Click Install and let the installer do it's thing.
  • Clone our repository and open src/SnesXM.sln in Visual Studio.
  • Hit F5 to Build and Run and you should be all set!

Contributions

Do you want to add a feature, report a bug, or propose a change to MushROMs? That's awesome! First, please refer to our Contributing file. We use it in hopes having the best working environment we can.

Credits

Major contributors to MushROMs

License

SnesXM: A Super NES Emulator in C# Copyright (C) 2018 Nelson Garcia

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.