"Markup" Authors file and README-SDL with markdown
This commit is contained in:
punkrockguy318
parent
52040a57c9
commit
35f6b0db92
|
|
@ -0,0 +1,72 @@
|
|||
Authors
|
||||
=======
|
||||
|
||||
A list of people who have contributed code to FCE Ultra, or have had their code
|
||||
placed in FCE Ultra by others.
|
||||
|
||||
Pre-2.0 FCE / FCE Ultra Contributors
|
||||
------------------------------------
|
||||
_These authors contributed exclusively to pre-2.0 versions,
|
||||
but much of their code remains in 2.0 builds_
|
||||
|
||||
* BERO - bero at geocities.co.jp - Base FCE code.
|
||||
|
||||
* Xodnizel - Most of the base FCE Ultra code
|
||||
|
||||
* Aaron Oneal - http://www.morphgear.com - Many changes to compile with MSVC and first frame skipping code
|
||||
|
||||
* Joe Nahmias - Man pages
|
||||
|
||||
* Paul Kuliniewicz - kuliniew at purdue.edu - Various code for the original SDL port.
|
||||
|
||||
* Quietust - quietust at ircN dot org - VRC7 "translation" code.
|
||||
|
||||
* Ben Parnell - Windows debugging tools
|
||||
|
||||
* Parasyte & bbitmaster - Enhanced Windows debugging tools
|
||||
|
||||
* blip & nitsuja - Rerecording support
|
||||
|
||||
FCEUX >= 2.0 Contributors
|
||||
-------------------------
|
||||
* SP - document thyself (sf:rheiny) - Enhanced Windows debugging tools
|
||||
|
||||
* zeromus - mgambrell at gmail dot com (sf:zeromus) - Core architecture refactoring and merging - Windows driver maintenance
|
||||
|
||||
* adelikat - document thyself (sf:adelikat) - UI cleanup, project management, Win32 features & maintenence, TAS tools, documentation
|
||||
|
||||
* CaH4e3 - CaH4e3 at mail dot ru (sf: cah4e3) - Mappers
|
||||
|
||||
* Luke Gustafson - (sf:???) - Windows TAS and movie recording enhancements
|
||||
|
||||
* qfox - (sf:qfox) - lua scripting fucntions, luabot, basicbot (no longer implemented), various lua scripts
|
||||
|
||||
* _mz - document thyself (mauzus) - Windows driver maintenance and cleanup
|
||||
|
||||
* UncombedCoconut - UncombedCoconut at gmail dot com (sf:jeblanchard) - Build system and cross-compilation support - Driver maintenance and refactoring
|
||||
|
||||
* DWEdit - Debugger additions
|
||||
|
||||
* AnS - ansstuff at yandex dot ru (sf:ansstuff) - Bugfixes and additions, TAS Editor v1.0
|
||||
|
||||
FCEUX (>=2.0) Linux/SDL Developers
|
||||
----------------------------------
|
||||
_These guys concentrated on keeping fceux the premiere linux/portable nes emu._
|
||||
|
||||
* Lukas Sabota - ltsmooth42 at gmail dot com (sf:punkrockguy318) - Head FceuX-SDL developer - GTK GUI, complete overhaul of SDL port, build scripts; maintainence; docs
|
||||
|
||||
* Shinydoofy - sf:shinydoofy - SDL maintenence
|
||||
|
||||
* Soules - gimmedonutnow at gmail dot com (sf:gimmedonutnow) - Linux SDL driver maintenance
|
||||
|
||||
* radsaq - radsaq at gmail dot com (sf:radsaq) - Build system, testing, and random cleanups
|
||||
|
||||
* Bryan Cain - sf:plombo - Patch to embed SDL in the GTK+ GUI, miscellaneous other SDL and GTK+ contributions
|
||||
|
||||
Included components:
|
||||
--------------------
|
||||
* Mitsutaka Okazaki - YM2413 emulator.
|
||||
|
||||
* Andrea Mazzoleni - Scale2x/Scale3x scalers
|
||||
|
||||
* Gilles Vollant - unzip.c PKZIP fileio
|
||||
99
Authors.txt
99
Authors.txt
|
|
@ -1,99 +0,0 @@
|
|||
A list of people who have contributed code to FCE Ultra, or have had their code
|
||||
placed in FCE Ultra by others.
|
||||
|
||||
-----------------------------------------
|
||||
<2.0 - These authors contributed exclusively to pre-2.0 versions,
|
||||
but much of their code remains in 2.0 builds
|
||||
|
||||
BERO - bero at geocities.co.jp
|
||||
Base FCE code.
|
||||
|
||||
Xodnizel
|
||||
Most of the base FCE Ultra code
|
||||
|
||||
Aaron Oneal - http://www.morphgear.com
|
||||
Many changes to compile with MSVC and first frame skipping code
|
||||
|
||||
Joe Nahmias
|
||||
Man pages
|
||||
|
||||
Paul Kuliniewicz - kuliniew at purdue.edu
|
||||
Various code for the official SDL port.
|
||||
|
||||
Quietust - quietust at ircN dot org
|
||||
VRC7 "translation" code.
|
||||
|
||||
Ben Parnell
|
||||
Windows debugging tools
|
||||
|
||||
Parasyte & bbitmaster
|
||||
Enhanced Windows debugging tools
|
||||
|
||||
blip & nitsuja
|
||||
Rerecording support
|
||||
|
||||
-----------------------------------------
|
||||
>= 2.0 - Incorporates new contributions from:
|
||||
|
||||
SP - document thyself (sf:rheiny)
|
||||
Enhanced Windows debugging tools
|
||||
|
||||
zeromus - mgambrell at gmail dot com (sf:zeromus)
|
||||
Core architecture refactoring and merging
|
||||
Windows driver maintenance
|
||||
|
||||
adelikat - document thyself (sf:adelikat)
|
||||
UI cleanup, project management, Win32 features & maintenence, TAS tools, documentation
|
||||
|
||||
CaH4e3 - CaH4e3 at mail dot ru (sf: cah4e3)
|
||||
Mappers
|
||||
|
||||
Luke Gustafson - (sf:???)
|
||||
Windows TAS and movie recording enhancements
|
||||
|
||||
qfox - (sf:qfox)
|
||||
lua scripting fucntions, luabot, basicbot (no longer implemented), various lua scripts
|
||||
|
||||
_mz - document thyself (mauzus)
|
||||
Windows driver maintenance and cleanup
|
||||
|
||||
UncombedCoconut - UncombedCoconut at gmail dot com (sf:jeblanchard)
|
||||
Build system and cross-compilation support
|
||||
Driver maintenance and refactoring
|
||||
|
||||
DWEdit
|
||||
Debugger additions
|
||||
|
||||
AnS - ansstuff at yandex dot ru (sf:ansstuff)
|
||||
Bugfixes and additions, TAS Editor v1.0
|
||||
|
||||
---------linux devvers---------
|
||||
>= 2.0 - These guys concentrated on keeping fceux the premiere
|
||||
linux-portable nes emu
|
||||
|
||||
Shinydoofy - sf:shinydoofy
|
||||
SDL maintenence
|
||||
|
||||
Lukas Sabota - ltsmooth42 at gmail dot com (sf:punkrockguy318)
|
||||
Head SDL developer
|
||||
|
||||
Soules - gimmedonutnow at gmail dot com (sf:gimmedonutnow)
|
||||
Linux SDL driver maintenance
|
||||
|
||||
radsaq - radsaq at gmail dot com (sf:radsaq)
|
||||
Build system, testing, and random cleanups
|
||||
|
||||
Bryan Cain - sf:plombo
|
||||
Patch to embed SDL in the GTK+ GUI, miscellaneous other SDL and GTK+ contributions
|
||||
|
||||
-----------------------------------------
|
||||
Included components:
|
||||
|
||||
Mitsutaka Okazaki
|
||||
YM2413 emulator.
|
||||
|
||||
Andrea Mazzoleni
|
||||
Scale2x/Scale3x scalers
|
||||
|
||||
Gilles Vollant
|
||||
unzip.c PKZIP fileio
|
||||
2
INSTALL
2
INSTALL
|
|
@ -1,4 +1,4 @@
|
|||
To compile and install FCEUX for SDL, follow the instructions in the README-SDL file.
|
||||
To compile and install FCEUX for SDL, follow the instructions in the README-SDL.md file.
|
||||
|
||||
To compile the netplay server, run "scons fceux-server" or run "make" in the "fceux-server" directory.
|
||||
|
||||
|
|
|
|||
100
README-SDL
100
README-SDL
|
|
@ -1,100 +0,0 @@
|
|||
FCEUX SDL 2.1.6 SDL README
|
||||
By Lukas Sabota (punkrockguy318)
|
||||
http://www.fceux.com
|
||||
Last Modified: February 20, 2012
|
||||
|
||||
Table of Contents
|
||||
1. Requirements
|
||||
2. Installation
|
||||
3. Compile-time options
|
||||
4. GUI
|
||||
5. LUA Scripting
|
||||
5. FAQ
|
||||
6. Contact
|
||||
|
||||
1. Requirements
|
||||
* libsdl1.2 - It is strongly recommended that you upgrade to the latest
|
||||
version of sdl (1.2.15 at the time of writing).
|
||||
* scons - Required to build fceux.
|
||||
* libgtk2.0 (optional) - version >= 2.24 recommended
|
||||
* libgtk3.0 (optional) - this compiles as of fceux 2.1.6.
|
||||
|
||||
2. Installation
|
||||
Fceux can be compiled and built using the scons build system. To compile, run:
|
||||
|
||||
scons
|
||||
|
||||
After a sucessful compilation, the fceux binary will be generated to
|
||||
./src/fceux . You can install fceux to your system with the following command:
|
||||
|
||||
scons install
|
||||
|
||||
You can optionally define a prefix:
|
||||
|
||||
scons --prefix=/usr/local install
|
||||
|
||||
You can choose to install the lua scripts (located in output/luaScripts) to a directory of your choosing:
|
||||
|
||||
cp -R output/luaScripts /usr/local/some/directory/that/i/will/find/later
|
||||
|
||||
3. Compile-time options
|
||||
You can enable and disable certain features of fceux at build time.
|
||||
To edit these options, edit the "BoolOptions" following the "opts.AddVariables" method
|
||||
at the head of the "SConstruct" file in this source directory. The
|
||||
default options will be fine for most users, but power users may want to
|
||||
tweak some of these options.
|
||||
|
||||
4. GUI
|
||||
You can enable the GTK GUI by setting GTK to 1 in the SConstruct build file.
|
||||
Gfceux is deprecatiated in favor of the new GTK GUI. You can disable it at
|
||||
run-time by passing the --nogui option, or disable it build time by setting
|
||||
GTK to 0 in the SConstruct file. If you prefer GTK3 to GTK2, you can set the
|
||||
GTK3 BoolVariable to 1 in the SConstruct.
|
||||
5. LUA Scripting
|
||||
FCEUX comes equipped with a LUA scripting engine that opens up endless in-game scripting capabilities. You can enable LUA at build time by enabling the "LUA" BoolVariable in the SConstruct file.
|
||||
|
||||
The LUA scripts that are shipped with fceux are located in:
|
||||
|
||||
$source_directory/output/luaScripts
|
||||
|
||||
You should be able to run most of the scripts in this directory out of the box. However, some of the the lua scripts require functionality from the "auxlib.lua" library. This file can be found in "./bin/auxlib.lua" or "./src/auxlib.lua". You will need to place this file in the LUA library search path if a script bombs out looking for auxlib.lua, it will let you know where it looking for it (/usr/local/lib/lua/5.1/ on my particular system). You can simply copy the auxlib to a preferred location to utilize the functions in the auxiliary lua library.
|
||||
|
||||
In addition, some of the lua scripts require functionality from the "iup" GUI library. You can obtain binaries and source for "iup" upstream (http://www.tecgraf.puc-rio.br/iup/), but I would recommend obtaining packages from your Linux distribution if you are able, as it can be difficult to compile or get the binaries working correctly on a given system.
|
||||
|
||||
You will need to add the location that the libiup*.so files to the LUA_CPATH. This can be done with the following command (please note that the location where iup is installed with vary based on how you installed iup):
|
||||
|
||||
export LUA_CPATH="/path/to/iup/lib/lib?51.so;"
|
||||
|
||||
On my Arch Linux system, it turned out to be the following:
|
||||
|
||||
export LUA_CPATH="/usr/local/lib/lua/5.1/lib?51.so;"
|
||||
|
||||
Finally, if any scripts complaints about "attempt to index global 'iup' (a nil value)", this means that "iup" needs to be explicitly loaded into the script. You can add the following line to the head of script to manually load "iup":
|
||||
|
||||
require("iuplua")
|
||||
|
||||
The "iup" libraries are admittedly time-consuming, difficult, and an overall pain-in-the-ass to install and configure on a Linux system. However, if you follow the above steps you should be able to achieve iup functionality (GUI elements) in fceux lua scripts if you so desire.
|
||||
|
||||
6. FAQ
|
||||
|
||||
Q. I'm having issues with my sound!
|
||||
A. First of all, for the best sound quality be sure you are using SDL 1.2.14 or later. Versions 1.2.13 and earlier are known to have problems with fceux! Next, try different SDL audio drivers to see if this makes any difference. You can do this by using this command before running fceux:
|
||||
|
||||
export SDL_AUDIODRIVER=driver
|
||||
|
||||
where driver is either:
|
||||
'pulse' for pulseaudio
|
||||
'alsa' for ALSA
|
||||
'dsp' for OSS
|
||||
'esd' for ESD
|
||||
|
||||
There are sound options that you can tweak at runtime through command line switches:
|
||||
|
||||
-soundq x internal sound quality hack value (0 off)
|
||||
-soundrate x sound rate (sane values: 28000 48000
|
||||
-soundbuffersize x (in ms) sane values (30, 50, 100, 120)
|
||||
|
||||
* Running fceux through esddsp is known to fix some audio issues with pulseaudio on some older Ubuntu versions.
|
||||
|
||||
7. Contact
|
||||
If you have an issue with fceux, report it in the sourceforge bug tracker (see fceux.com). If you would like to contact the author of this readme personally, e-mail LTsmooth42 <at> gmail <dot> com. You can also check us out at #fceu on irc.freenode.net.
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
FCEUX SDL 2.1.6 SDL README
|
||||
==========================
|
||||
By Lukas Sabota (sf: punkrockguy318)
|
||||
|
||||
http://www.fceux.com
|
||||
|
||||
Last Modified: March 6, 2012
|
||||
|
||||
Table of Contents
|
||||
-----------------
|
||||
|
||||
1. Requirements
|
||||
2. Installation
|
||||
3. Compile-time options
|
||||
4. GUI
|
||||
5. LUA Scripting
|
||||
5. FAQ
|
||||
6. Contact
|
||||
|
||||
1 - Requirements
|
||||
----------------
|
||||
* libsdl1.2 - It is strongly recommended that you upgrade to the latest
|
||||
version of sdl (1.2.15 at the time of writing).
|
||||
* scons - Required to build fceux.
|
||||
* libgtk2.0 (optional) - version >= 2.24 recommended
|
||||
* libgtk3.0 (optional) - this compiles as of fceux 2.1.6.
|
||||
|
||||
2 - Installation
|
||||
----------------
|
||||
Fceux can be compiled and built using the scons build system. To compile, run:
|
||||
|
||||
scons
|
||||
|
||||
After a sucessful compilation, the fceux binary will be generated to
|
||||
./src/fceux . You can install fceux to your system with the following command:
|
||||
|
||||
scons install
|
||||
|
||||
You can optionally define a prefix:
|
||||
|
||||
scons --prefix=/usr/local install
|
||||
|
||||
You can choose to install the lua scripts (located in output/luaScripts) to a directory of your choosing:
|
||||
|
||||
cp -R output/luaScripts /usr/local/some/directory/that/i/will/find/later
|
||||
|
||||
3 - Compile-time options
|
||||
------------------------
|
||||
You can enable and disable certain features of fceux at build time.
|
||||
To edit these options, edit the "BoolOptions" following the "opts.AddVariables" method
|
||||
at the head of the "SConstruct" file in this source directory. The
|
||||
default options will be fine for most users, but power users may want to
|
||||
tweak some of these options.
|
||||
|
||||
4 - GUI
|
||||
-------
|
||||
You can enable the GTK GUI by setting GTK to 1 in the SConstruct build file.
|
||||
GfceuX is deprecatiated in favor of the new GTK GUI. You can disable the GTK GUI at
|
||||
run-time by passing the --nogui option, or disable it at build=time by setting
|
||||
GTK to 0 in the SConstruct file. If you prefer GTK3 to GTK2, you can set the
|
||||
GTK3 BoolVariable to 1 in the SConstruct.
|
||||
|
||||
5 - LUA Scripting
|
||||
-----------------
|
||||
FCEUX comes equipped with a LUA scripting engine that opens up endless in-game scripting capabilities. You can enable LUA at build time by enabling the "LUA" BoolVariable in the SConstruct file.
|
||||
|
||||
The LUA scripts that are shipped with fceux are located in:
|
||||
|
||||
$source_directory/output/luaScripts
|
||||
|
||||
You should be able to run most of the scripts in this directory out of the box. However, some of the the lua scripts require functionality from the "auxlib.lua" library. This file can be found in "./bin/auxlib.lua" or "./src/auxlib.lua". You will need to place this file in the LUA library search path if a script bombs out looking for auxlib.lua, it will let you know where it looking for it (/usr/local/lib/lua/5.1/ on my particular system). You can simply copy the auxlib to a preferred location to utilize the functions in the auxiliary lua library.
|
||||
|
||||
In addition, some of the lua scripts require functionality from the "iup" GUI library. You can obtain binaries and source for "iup" upstream (http://www.tecgraf.puc-rio.br/iup/), but I would recommend obtaining packages from your Linux distribution if you are able, as it can be difficult to compile or get the binaries working correctly on a given system.
|
||||
|
||||
You will need to add the location that the libiup*.so files to the LUA_CPATH. This can be done with the following command (please note that the location where iup is installed with vary based on how you installed iup):
|
||||
|
||||
export LUA_CPATH="/path/to/iup/lib/lib?51.so;"
|
||||
|
||||
On my Arch Linux system, it turned out to be the following:
|
||||
|
||||
export LUA_CPATH="/usr/local/lib/lua/5.1/lib?51.so;"
|
||||
|
||||
Finally, if any scripts complaints about "attempt to index global 'iup' (a nil value)", this means that "iup" needs to be explicitly loaded into the script. You can add the following line to the head of script to manually load "iup":
|
||||
|
||||
require("iuplua")
|
||||
|
||||
The "iup" libraries are admittedly time-consuming, difficult, and an overall pain-in-the-ass to install and configure on a Linux system. However, if you follow the above steps you should be able to achieve iup functionality (GUI elements) in fceux lua scripts if you so desire.
|
||||
|
||||
6 - FAQ
|
||||
-------
|
||||
|
||||
* Q. I'm having issues with my sound!
|
||||
* A. First of all, for the best sound quality be sure you are using SDL 1.2.14 or later. Versions 1.2.13 and earlier are known to have problems with fceux! Next, try different SDL audio drivers to see if this makes any difference. You can do this by using this command before running fceux:
|
||||
|
||||
export SDL_AUDIODRIVER=driver
|
||||
|
||||
where driver is either: 'pulse' for pulseaudio;' alsa' for ALSA; 'dsp' for OSS; 'esd' for ESD; see SDL documentation for details.
|
||||
|
||||
There are sound options that you can tweak at runtime through command line switches:
|
||||
|
||||
* -soundq x internal sound quality hack value (0 off)
|
||||
* -soundrate x sound rate (sane values: 28000 48000
|
||||
* -soundbuffersize x (in ms) sane values (30, 50, 100, 120)
|
||||
|
||||
Running fceux through esddsp is known to fix some audio issues with pulseaudio on some older Ubuntu versions.
|
||||
|
||||
7 - Contact
|
||||
-----------
|
||||
If you have an issue with fceux, report it in the sourceforge bug tracker (see fceux.com). If you would like to contact the author of this readme personally, e-mail LTsmooth42 <at> gmail <dot> com. You can also check us out at #fceu on irc.freenode.net.
|
||||
|
|
@ -10,5 +10,5 @@ Hard tabs only! Please! src/drivers/sdl/* entirely consists of hard tabbed cod
|
|||
|
||||
Return Statements
|
||||
-----------------
|
||||
Please use the "return 0;" style return statements instead of the "return(0)" style return statements.
|
||||
Please use the "return 0;" style return statements instead of the "return(0);" style return statements.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue