README.md 4.7 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
Bryan Barnes's avatar
Bryan Barnes committed
29
 - note that API 9 is hidden (you must check to show obsolete in SDK manager)
hooby3dfx's avatar
hooby3dfx committed
30
* Ant
31
 - http://ant.apache.org/
32

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

37
cd shell/android/
38
39

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

ant debug
```

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

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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


78
79
80
81
82
Translations
------------
New and updated translations are always appreciated!
All we ask is that you not use “regional” phrases that may not be generally understood.

83
Translations can be submitted as a pull request
84

85

86
Beta versions
87
-------------
Bryan Barnes's avatar
Bryan Barnes committed
88
[![Build Status](https://travis-ci.org/reicast/reicast-emulator.svg?branch=master)](https://travis-ci.org/reicast/reicast-emulator)
Bryan Barnes's avatar
Bryan Barnes committed
89

90
91
92
93
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

94

95
96
97
98
Donations and stuff
-------------------
Well, glad you liked the project so far!

99
We're currently short on hardware.
100

101
102
103
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.
104
105
106
107
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
108
* LG P990
109
110
111
112
* Archos 10G9
* Some Chinese tablet
* OUYA
* Various development boards
113
* GCW Zero
114

115
116
We had to buy all of these, except the GCW Zero and a BeagleBone which were
donated (Thanks! You rock!)
117
118
119

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.
120
121
122
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 :)
123

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

127
128
Other Testing
-------------
129
130
131
132
133
134
135
136
137
138
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:
139
140
141
142
* Nvidia Shield
* Nexus 5 / 7
* Xperia Play

143
144
145
Team
----

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

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

150
151
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
152
153


154
155
Special thanks
--------------
156
157
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
158
159
160

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