flycast/README.md

163 lines
4.7 KiB
Markdown
Raw Normal View History

2013-12-19 17:10:14 +00:00
reicast
===========
reicast is a multi-platform Sega Dreamcast emulator.
2013-12-19 17:10:14 +00:00
This is a developer-oriented resource, if you just want bins head over to http://reicast.com/
2013-12-19 17:10:14 +00:00
Caution
-------
The source is a mess, and I need sleep.
We had to discover some interesting arm bugs on the cleaned/refactored branch right after the release.
Expect a much improved changed folder/make structure soon.
Rebranding/forks
----------------
If you are interested into further porting/adapting/whatever, *please* don't fork off. I hate that. Really.
2013-12-19 18:25:12 +00:00
Let's try to keep everything under a single project :)
2013-12-19 17:10:14 +00:00
Building for Android
2013-12-19 17:10:14 +00:00
--------------------
2014-01-07 16:30:52 +00:00
Tools required:
* Latest Android SDK
- http://developer.android.com/sdk/index.html
* NDK r8b or newer
- https://developer.android.com/tools/sdk/ndk/index.html
- If are not using r9c+, comment the "NDK_TOOLCHAIN_VERSION := 4.8" in shell/android/jni/Application.mk and shell/android/xperia/jni/Application.mk
* Android 4.4 (API 19) & Android 2.3.1 (API 9)
- http://developer.android.com/sdk/installing/adding-packages.html
2014-03-12 02:30:14 +00:00
- note that API 9 is hidden (you must check to show obsolete in SDK manager)
2014-01-07 16:34:23 +00:00
* Ant
- http://ant.apache.org/
2013-12-19 17:10:14 +00:00
2014-01-07 16:30:52 +00:00
From project root directory:
```
export ANDROID_NDK=/ # Type the full path to your NDK here
cd shell/android/
android update project -p . --target "android-19"
2013-12-19 17:10:14 +00:00
ant debug
```
Building for iOS
----------------
Tools required:
* Latest Xcode
- https://developer.apple.com/xcode/downloads/
* An iOS device (reicast will not compile for the iOS Simulator)
* iOS 5.x ~ 7.x
* iOSOpenDev if developing without an official Apple certificate
- http://iosopendev.com/download/
From project root directory:
```
cd shell/ios/
xcodebuild -configuration Release
```
Building for Linux
------------------
The code is only currently compatible with 32bit architectures so you will need
to install 32bit libs to build reicast.
Requirements:
* build-essential
* libasound
* libegl1-mesa-dev
* libgles2-mesa-dev
* libasound2-dev
To build the project, go to shell/lin86 and run make
Translations
------------
New and updated translations are always appreciated!
All we ask is that you not use “regional” phrases that may not be generally understood.
Translations can be submitted as a pull request
Squash changes from andoidui into single commit Integrate previously locked settings with valid user warning Put a note about the beta compile link in the README.md Add a super fancy about that supports Github commit logs Revise about with git log, Highlight current build in commits Check for a null value when getting the current commit sha Chinese Simplified Translation from @weihan1102 Rename Simplified Chinese res folder for proper complie Add links to the website and beta compile site from about Add option for custom mapping to set joystick to non-dpad Fix a missing check for the user saved value of the A button The Moga only operates one way, there is no variation test Add region values, Set cable to match formatting of others Reduce the number of random string array calls, jsCompat It was unnecessary to keep getting the array, It was even less necessary to keep getting the preference values. The port identification letters are set multi-lingual values. Label the about links to prevent any confusion (Not mirrors) Missing a check on the motion events to determine compat Add a check to verify Kitkat, Remove the standard override The new API verification complains about the Override, so this is a preventative step for if and when it is updated. It may also prevent some issues with compatibility. Run organize imports to reduce the amount of excess code Add a controller option to go to custom layout from selection Prevent a leak where multiple items were highlighted in list @AndroidGX French Translation resources
2014-01-27 15:52:23 +00:00
Beta versions
-------------
2014-05-10 02:31:05 +00:00
[![Build Status](https://travis-ci.org/reicast/reicast-emulator.svg?branch=master)](https://travis-ci.org/reicast/reicast-emulator)
2014-05-10 02:32:42 +00:00
2014-06-18 22:17:57 +00:00
Official builds from the reicast ci service can be found at http://builds.reicast.com/
Additional builds (iOS & android) can be found at [angelxwind's](http://reicast.angelxwind.net/) buildbot
2013-12-19 17:10:14 +00:00
Donations and stuff
-------------------
Well, glad you liked the project so far!
We're currently short on hardware.
2013-12-19 17:10:14 +00:00
If you would like to donate some devices, get in touch at team@reicast.com.
GLES3 capable stuff, some mainstream hardware and rarities would be extremely
appreciated.
2013-12-19 17:10:14 +00:00
Keep in mind we're located in Greece for the most part
This has been tested/developed on
* Galaxy tab 7.0 Plus
2013-12-21 14:53:24 +00:00
* LG P990
2013-12-19 17:10:14 +00:00
* Archos 10G9
* Some Chinese tablet
* OUYA
* Various development boards
* GCW Zero
2013-12-19 17:10:14 +00:00
We had to buy all of these, except the GCW Zero and a BeagleBone which were
donated (Thanks! You rock!)
2013-12-19 17:10:14 +00:00
Apart from that, we don't accept monetary donations right now.
We also don't plan to be releasing a premium version at any store.
Most of the project has been developed by drk||Raziel (aka, skmp, drk, Raz,
etc) but it has been based on the works of multiple people. It would be
extremely unfair to charge for it and get all the credit :)
2013-12-19 17:18:53 +00:00
We're planning for an indiegogo campaign later on to help with sustained
development and running costs, so follow @reicastdc on twitter for updates
2013-12-19 17:10:14 +00:00
Other Testing
-------------
Devices tested by the reicast team:
* Apple iPhone 4 GSM Rev0 (N90AP)
* Apple iPhone 4 CDMA (N92AP)
* Apple iPod touch 4 (N81AP)
* Apple iPod touch 3G (N18AP)
* Apple iPhone 3GS (N88AP)
* Apple iPhone 5s
* Apple iPad 3
* Sony Xperia X10a (es209ra)
* Amazon Kindle Fire HD 7 (tate-pvt-08)
* Nvidia Shield portable
* Nvidia Shield tablet
* Samsung Galaxy Note 4
* LG Nexus 5
* Asus Nexus 7 (2013)
2013-12-19 17:10:14 +00:00
Team
----
2013-12-23 11:27:19 +00:00
You can check the currently active committers on [the pretty graphs page](https://github.com/reicast/reicast-emulator/graphs/contributors)
2013-12-19 17:18:53 +00:00
Our IRC channel is [#reicast @ chat.freenode.net](irc://chat.freenode.net/reicast).
2013-12-19 17:10:14 +00:00
The original reicast team consisted of drk||Raziel (mostly just writing code),
PsyMan (debugging/testing and everything else) and a little bit of gb_away
2013-12-19 17:10:14 +00:00
2013-12-23 11:26:19 +00:00
Special thanks
--------------
In previous iterations a lot of people have worked on this, notably David
Miller (aka, ZeZu), the nullDC team, friends from #pcsx2 and all over the world :)
2014-01-22 00:05:57 +00:00
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/reicast/reicast-emulator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")