ShuriZma
/
fceux
mirror of https://github.com/TASEmulators/fceux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme.md 

Customized readme to be specific for Emu-Gators FCEUX project, and added instructions so that any user can easily set-up and use our current build of FCEUX.
This commit is contained in:
Artur Bekker 2022-11-26 17:55:26 -05:00 committed by GitHub
parent 334294a06e
commit c8b755545b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
readme.md
View File

@ -1,21 +1,20 @@
# fceux [![Build status](https://ci.appveyor.com/api/projects/status/github/TASEmulators/fceux?branch=master&svg=true)](https://ci.appveyor.com/project/zeromus/fceux)
# Emu-Gators FCEUX [![Build status](https://ci.appveyor.com/api/projects/status/github/TASEmulators/fceux?branch=master&svg=true)](https://ci.appveyor.com/project/zeromus/fceux)
An open source NES Emulator for Windows and Unix that features solid emulation accuracy and state of the art tools for power users. For some reason casual gamers use it too.
## Builds and Releases
Our goal is to customize FCEUX in order to deliver users a more realistic experience when playing games utilizing the Famicom Disk System.
Interim builds:
* Win32: [fceux-win32.zip](https://github.com/TASEmulators/fceux/releases/download/interim-build/fceux-win32.zip)
* Win64: [fceux-win64.zip](https://github.com/TASEmulators/fceux/releases/download/interim-build/fceux-win64.zip)
* Win64 Qt/SDL: [fceux-win64-QtSDL.zip](https://github.com/TASEmulators/fceux/releases/download/interim-build/fceux-win64-QtSDL.zip)
* Ubuntu: [fceux-ubuntu-x64.deb](https://github.com/TASEmulators/fceux/releases/download/interim-build/fceux-ubuntu-x64.deb)
* MacOSX: [fceux-Darwin.dmg](https://github.com/TASEmulators/fceux/releases/download/interim-build/fceux-Darwin.dmg)
* Status: [Appveyor](https://ci.appveyor.com/project/zeromus/fceux/)
## Build Instructions
The recommended way to build this repository is to clone and build it directly in Visual Studio. If you choose to do this, you will also need the Windows XP toolset. If it is not installed, go to "Tools" > "Get Tools and Features". Select "Individual Components" and then install "C++ Windows XP Support for VS 2017 (v141) tools". These solution files will compile FCEUX and some included libraries for full functionality.
But you might like mesen more: https://github.com/SourMesen/Mesen
You will also need to have "lua51.dll" in your system environment variables in order to be able to run Lua scripts. This can be done by downloading Lua 5.1.5 from the following link -
You should get releases from here: https://sourceforge.net/projects/fceultra/files/
https://sourceforge.net/projects/luabinaries/files/5.1.5/Tools%20Executables/lua-5.1.5_Win64_bin.zip/download
That's because github forces us to use tags we don't have for releases.
Once it is downloaded, unzip the files to a new folder somewhere on your computer. We recommend placing it in "Program Files". Next you will need to copy the path of this folder to your system environment variables (if placed in Program Files, the path will be something like "C:\Program Files\Lua"). Next, right-click the Windows icon in the bottom-left corner of your screen, and select "System". On this page, scroll down to the "Related settings" heading and select "Advanced system settings". On this page, click the "Environment Variables..." button. In this window, scroll down in the box labeled "System variables" until you reach "Path". Double click this line and you will see another window pop up, listing all your environment variables. Here press "New", and you will see another line get added. On this line, paste in the path of the Lua folder created earlier, and press "OK. Then press "OK" on the previous window, after which you will press "OK" on the intial window and the setup will be finished.
2.6.4 is the most recent release but most people are using the autobuilds.
Finally, in order to be able to run games utilizing the Famicom Disk System, which is the entire basis of our project, you will need to have the "disksys.rom" BIOS in the same directory as your executable fceux build. This can be found rather easily online, but the following link provides a version that can be opened and extracted using the 7-Zip Console -
https://www.mediafire.com/file/35cpj3ghyxeq34o/FamicomDiskSystemBIOS.rar/file
After building, in your cloned repository, navigate to the folder where your executable is found. If you built in Debug mode with x64 architecture, it should be in "fceux/vc/x64/Debug". Then, simply copy/extract the "disksys.rom" file into this directory, and you're all set to play Famicom Disk System games.