README.md 4.21 KB
Newer Older
1
2
reicast
===========
3
reicast is a multi-platform Sega Dreamcast emulator.
4

5
This is a developer-oriented resource, if you just want bins head over to http://reicast.com/
6
7
8
9
10
11
12
13
14
15
16

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.

17
Let's try to keep everything under a single project :)
18

19
Building for Android
20
--------------------
hooby3dfx's avatar
hooby3dfx committed
21
Tools required:
22
23
24
25
* Latest Android SDK
 - http://developer.android.com/sdk/index.html
* NDK r8b or newer
 - https://developer.android.com/tools/sdk/ndk/index.html
26
 - 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
27
* Android 4.4 (API 19) & Android 2.3.1 (API 9)
28
 - http://developer.android.com/sdk/installing/adding-packages.html
hooby3dfx's avatar
hooby3dfx committed
29
* Ant
30
 - http://ant.apache.org/
31

hooby3dfx's avatar
hooby3dfx committed
32
33
From project root directory:
```
34
export ANDROID_NDK=/ # Type the full path to your NDK here
35

36
cd shell/android/
37
38

android update project -p . --target "android-19"
39
40
41
42

ant debug
```

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
```

61
62
63
64
65
Translations
------------
New and updated translations are always appreciated!
All we ask is that you not use “regional” phrases that may not be generally understood.

66
Translations can be submitted as a pull request
67

68

69
Beta versions
70
-------------
Bryan Barnes's avatar
Bryan Barnes committed
71
[![Build Status](https://travis-ci.org/reicast/reicast-emulator.svg?branch=master)](https://travis-ci.org/reicast/reicast-emulator)
72
Automated Git builds can be found at http://reicast.angelxwind.net/ for iOS and Android.
73

74
75
76
77
Donations and stuff
-------------------
Well, glad you liked the project so far!

78
We're currently short on hardware.
79
80
81
82
83
84

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.
Keep in mind we're located in Greece for the most part

This has been tested/developed on
* Galaxy tab 7.0 Plus
MrPsyMan's avatar
MrPsyMan committed
85
* LG P990
86
87
88
89
* Archos 10G9
* Some Chinese tablet
* OUYA
* Various development boards
90
* GCW Zero
91

92
We had to buy all of these, except the GCW Zero and a BeagleBone which were donated (Thanks! You rock!)
93
94
95
96

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 
97
98
works of multiple people. It would be extremely unfair to charge for it and get all the credit :)

99
100
We're planning for an indiegogo campaign later on to help with sustained development and running costs, so follow @reicastdc on twitter for updates

101
102
Other Testing
-------------
103
104
105
106
107
108
109
110
111
112
These devices are tested by Karen/angelXwind:
* 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)
* Sony Xperia X10a (es209ra)
* Amazon Kindle Fire HD 7 (tate-pvt-08)

These devices are tested by contributors regularly:
113
114
115
116
* Nvidia Shield
* Nexus 5 / 7
* Xperia Play

117
118
119
Team
----

120
You can check the currently active committers on [the pretty graphs page](https://github.com/reicast/reicast-emulator/graphs/contributors)
121

122
Our IRC channel is [#reicast @ chat.freenode.net](irc://chat.freenode.net/reicast). 
123

124
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
125
126


127
128
129
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 :)
Bitdeli Chef's avatar
Bitdeli Chef committed
130
131
132

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/reicast/reicast-emulator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")