-
Notifications
You must be signed in to change notification settings - Fork 5
/
development.html
301 lines (254 loc) · 13.2 KB
/
development.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Stella: "A Multi-Platform Atari 2600 VCS Emulator"</title>
<link href="cssscreen.css" rel="stylesheet" media="screen">
<link href="cssprint.css" rel="stylesheet" media="print">
<link rel="icon" type="image/png" href="favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="favicon-16x16.png" sizes="16x16" />
</head>
<body id="development">
<div class="rightcolumn">
<div class="header"><img src="title.png" height="145" width="495"></div>
<div class="content">
<!---------------------------------------------------------------->
<p>The Stella project always welcomes new developers, either on a full-time basis
or just to fix your favorite bug. Feel free to email
<a href="mailto:[email protected]">Stephen Anthony</a> if you wish to contribute in any
way to the Stella project.</p>
<p>The first major hurdle for new developers is setting up a build environment, checking
out the code, and in general actually compiling the project for the first time. The
following is a description of how to do this for the three major platforms.
<h3><u>Linux/UNIX</u></h3>
<ol>
<li><p>Getting the required tools:
<p>Stella needs g++-11 or clang++-10 (with up-to-date C++20 support), make and
<a href="http://www.libsdl.org/download-2.0.php">SDL2</a> development libraries installed.
ZLib and PNG libraries are optional; Stella will use built-in versions if none
are installed system-wide. These packages are likely available through your distribution
repository. Consult your specific distribution for an explanation of installing new packages.
<p>Other packages may be needed depending on the distribution you use. The best thing
to do is try the compile, note any missing packages, and then install them through your
distribution repository.
<br/>
<li><p>Downloading the source code:
<p>The source for the latest release can always be found under "Stable Releases" on the
main webpage. However, you'd be better off working with the most recent code, located
in the <a href="https://github.com/stella-emu/stella">GitHub repository</a>. The following
command will <I>checkout</I> this code:
<div class="con">git clone https://github.com/stella-emu/stella.git</div>
<p>This will checkout from the <i>master branch</i> for local modifications. Please see below
for instructions on how to contribute changes back to Stella.
<p><B>Note: </B>You may be more familiar with graphical Git clients; these will work fine as well.
</li>
<br/>
<li><p>Compiling the source code:
<p><ol>
<li>Generic build — When testing changes or creating personal builds, it's best to use
the generic configure/make cycle:
<p><div class="con">cd 'location of stella source code'
./configure (--help for list of options)
make
make install (if you want to install locally)</div>
</li>
<li><p>Debian-based distributions:
<p><div class="con">cd 'location of stella source code'
dpkg-buildpackage</div>
</li>
</ol>
</li>
<br/>
<li><p>Contributing</p>
<p>
If you'd like to contribute to Stella, create a fork of the repository on github
and make your changes there. After you are done, place a <i>pull request</i> against the
Stella repository. This process is described in detail in the
<a href="https://help.github.com/articles/fork-a-repo/">github docs</a>.
</p>
<p>
If you do not want to create a github account, you can also create a diff of your
changes using
<div style="margin-bottom: 1rem" class="con">git diff</div>
and send it to the email address above. Please check out the
<a href="https://git-scm.com/docs/git-diff">git documentation</a> on how
to select particular commits for diffing.
</p>
<p>Before you start modifying code, it's best to <I>update</I> your local copy of the source code (so
that you can see changes that others have made). To do this, use the following command:
<div class="con">git pull</div>
</p>
</ol>
<br/>
<h3><u>Apple macOS</u></h3>
<ol>
<li><p>Getting the required tools:
<p>Stella needs macOS 12 and associated Xcode version for compilation. You will also need the SDL2 development libraries,
located at <a href="http://www.libsdl.org/download-2.0.php">libsdl.org</a>. You will need
to download <B>SDL2-2.0.14.dmg</B> (or newer, if available).
<br/>
<li><p>Downloading the source code:
<p>The source for the latest release can always be found under "Stable Releases" on the
main webpage. However, you'd be better off working with the most recent code, located
in the <a href="https://github.com/stella-emu/stella">GitHub repository</a>. The following
command will <I>checkout</I> this code:
<div class="con">git clone https://github.com/stella-emu/stella.git</div>
<p>This will checkout from the <i>master branch</i> for local modifications. Please see below
for instructions on how to contribute changes back to Stella.
<p><B>Note: </B>You may be more familiar with graphical Git clients; these will work fine as well.
</li>
<br/>
<li><p>Compiling the source code:
<p><ol>
<li>The Xcode project is located at <I>src/macos/stella.xcodeproj</I> and is for ARM M1 and 64-bit Intel machines.
</li>
<li><p>Place the <I>SDL.framework</I> bundle (located in the <B>SDL2 dmg</B> file
you downloaded earlier) into the <I>/Library/Frameworks</I> directory.
</li>
<li><p>Open the project file using Xcode 12.</li>
<li><p>Build the project by pressing Cmd-b, and run by pressing Cmd-r.</li>
<li><p><B>Optional:</B> creating a DMG for release:
<p><div class="con">cd 'location of stella source code'/src/macos
./Create_build.sh 'version #'</div>
<p>This will create a DMG installation archive on your desktop.
<p>The Stella.app bundle can be copied to your <I>Applications</I> folder, or wherever you
like on your system.
</li>
</ol>
</li>
<li><p>Contributing</p>
<p>
If you'd like to contribute to Stella, create a fork of the repository on github
and make your changes there. After you are done, place a <i>pull request</i> against the
Stella repository. This process is described in detail in the
<a href="https://help.github.com/articles/fork-a-repo/">github docs</a>.
</p>
<p>
If you do not want to create a github account, you can also create a diff of your
changes using
<div style="margin-bottom: 1rem" class="con">git diff</div>
and send it to the email address above. Please check out the
<a href="https://git-scm.com/docs/git-diff">git documentation</a> on how
to select particular commits for diffing.
</p>
<p>Before you start modifying code, it's best to <I>update</I> your local copy of the source code (so
that you can see changes that others have made). To do this, use the following command:
<div class="con">git pull</div>
</p>
</ol>
<br/>
<h3><u>Windows 7/8/10/11</u></h3>
<ol>
<li><p>Getting the required tools:
<p>Stella needs <a href="https://www.visualstudio.com/vs/community">Visual Studio C++ 2022</a>.
You will also need the SDL2 development libraries, located at <a href="https://github.com/libsdl-org/SDL/releases">GitHub</a>.
The version you want will be named SDL2-devel-2.2.x-VC.zip (where 'x' is dependent on the version); download the latest version.
<p>You will also need a Git client; the following assumes you are using <a href="https://tortoisegit.org">
TortoiseGit</a>.
<br/>
<li><p>Downloading the source code:
<p>The source for the latest release can always be found under "Stable Releases" on the
main webpage. However, you'd be better off working with the most recent code, located
in the <a href="https://github.com/stella-emu/stella">GitHub repository</a>. To <I>checkout</I>
this code, you will need to install TortoiseGit, which you downloaded above.
<p>Once TortoiseGit is installed, you should right-click somewhere in Windows Explorer where
you wish to download the files, right-click and select <B>Git Clone...</B> This will produce a window as follows:
<p><blockquote><img src="images/git_clone.png"/></blockquote>
<p>The <I>URL of repository</I> must be the same, but the <I>Checkout directory</I> will be
specific to your system.
<p>This will checkout from the <i>master branch</i> for local modifications.
Please see below for instructions on how to contribute changes back to Stella.
</li>
<li><p>Compiling the source code:
<p>Before compiling the code for the first time, you must set up your environment such that Visual Studio
can find the SDL development files:
<ol>
<li><p>Open the folder REPO_DIR\src\os\windows, similar to the following:
<p><blockquote><img src="images/vs_open.png"/></blockquote>
<li><p>Unzip the <B>SDL2-devel-2.2.x-VC.zip</B> file you downloaded above into this folder.
This will create a folder named SDL2-2.2.x (where 'x' depends on the version you downloaded),
which should contain, among other things, folders named 'include' and 'lib'.
<li><p>Rename this folder to 'SDL'. In the end, you must have a folder named SDL in src\os\windows,
and the folder must contain 'include' and 'lib' folders as well.
<li><p>Open the Visual Studio project file (Stella.vcxproj) and build the project; it should run to completion,
perhaps with some warnings.
<li><p>If you try to run at this point, it will probably complain that it can't find
SDL2.dll. Manually copy this file from the SDL folder to the following location:
<blockquote><pre>
For the 64-bit version: <I>x64\Release</I> and <I>x64\Debug</I> subfolders
</pre></blockquote>
<li>You may also get an error that the libraries <B>msvcp140.dll</B> and/or <B>msvcr140.dll</B> are not available.
If so, you will need to download them from
<a href="https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads">Visual C++ Redistributable Packages for Visual Studio 2017</a>
</li>
</ol>
</li>
<li><p>Contributing</p>
<p>
If you'd like to contribute to Stella, create a fork of the repository on github
and make your changes there. After you are done, place a <i>pull request</i> against the
stella repository. This process is described in detail in the
<a href="https://help.github.com/articles/fork-a-repo/">github docs</a>.
</p>
<p>
If you do not want to create a github account, you can also create a diff of your
changes and send it to the email address above. To do this, right-click
on the local repository directory and select <B>TortoiseGit -> Create Patch Serial...</B>
</p>
<p>
Before you start modifying code, it's best to <I>update</I> your local copy of the source code (so
that you can see changes that others have made). To do this, right-click
on the local repository directory and select <B>TortoiseGit -> Pull...</B>
</p>
</ol>
<!---------------------------------------------------------------->
</div>
<div class="footer"><hr><p>Copyright © 1995-2024
<a href="http://www.bradfordmott.com">Bradford W. Mott</a>,
<a href="http://minbar.org">Stephen Anthony</a> and
<a href="theteam.html">The Stella Team</a>
<br/> Site Updated October 5, 2024</p>
</div>
</div>
<div class="leftcolumn"><img src="menu-title.gif" width="125" height="125">
<div class="menuheader">General</div>
<ul>
<li><a href="index.html" id="about" >About Stella</a>
<li><a href="donations.html" id="donations" >DonationWare</a>
<li><a href="changelog.html" id="news" >ChangeLog</a>
<li><a href="screenshots.html" id="screenshots" >Screen Shots</a>
<li><a href="theteam.html" id="team" >The Team</a>
<li><a href="credits.html" id="credits" >Credits List</a>
<li><a href="todo.html" id="todo" >Todo List</a>
</ul>
<div class="menuheader">Documentation</div>
<ul>
<li><a href="docs/index.html" id="guide">User's Guide</a>
<li><a href="faq.html" id="faq">FAQ (Frequently Asked Questions)</a>
</ul>
<div class="menuheader">Downloads</div>
<ul>
<li><a href="downloads.html" id="stable" >Stable Releases</a>
<li><a href="development.html" id="development" >Development</a>
</ul>
<div class="menuheader">Important Links</div>
<ul>
<li><a href="atari2600links.html" id="atarilinks" >Atari 2600 Links</a>
<li><a href="homebrew.html" id="homebrew" >Homebrew Development</a>
</ul>
<div> </div>
<a href="http://www.2600-daptor.com"><img src="2600-daptor_logo.png" alt="2600-daptor" /></a>
<br/><br/>
<a href="http://www.grandideastudio.com/portfolio/stelladaptor-2600"><img src="stelladaptor_logo.png" alt="Stelladaptor" /></a>
<br/><br/>
<a href="http://bliss-box.net"><img src="blissbox_logo.png" alt="Bliss-Box" /></a>
<br/><br/>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_s-xclick" />
<input type="hidden" name="hosted_button_id" value="HFYGAYVAY9GT6" />
<input type="image" src="images/ppdonate.png" width="120" border="0" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" />
<img alt="" border="0" src="https://www.paypal.com/en_CA/i/scr/pixel.gif" width="1" height="1" />
</form>
</div>
</body>
</html>