Skip to content

Commit e20b70a

Browse files
einarfeinarf
authored
Various doc improvements (#2335)
* Move how to get help into community * Move games images + add local versions * About + Community * Solve duplicate links
1 parent 9da2cbf commit e20b70a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+118
-50
lines changed

‎doc/_archive/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:hide-toc:
22

3-
.. image:: images/arcade-logo.svg
3+
.. image:: images/logo/arcade-logo.svg
44
:width: 10%
55
:class: right-image
66

‎doc/about/intro.rst‎

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,54 @@
22
Introduction
33
============
44

5-
Start here
6-
----------
5+
Welcome to the official documentation of Arcade.
76

8-
Some Introduction
7+
Learning Resources
8+
------------------
9+
10+
Arcade offers several resources to help you get started regardless of your
11+
experience level. People learn in different ways, so we try to offer a variety
12+
of resources to help you learn.
13+
14+
* Examples
15+
* Tutorials
16+
* API Reference
17+
* Arcade Book
18+
* Skill Tree
919

1020
Community driven
1121
----------------
1222

13-
Created by the community. For the community.
23+
Arcade is a community driven project. We cannot exist without the help of our users.
24+
You don't need to be an experienced programmer or a game developer to help us.
25+
You can help us by reporting bugs, suggesting improvements, pointing out issues
26+
in documentation or even by sharing your projects with us.
27+
28+
* More information about ways to contribute: :ref:`how-to-contribute`.
29+
* Also see :ref:`community-locations` for more information about where to find the
30+
community.
31+
32+
History
33+
-------
34+
35+
The Python Arcade Library was created by Paul Vincent Craven. Paul was a professor
36+
of Computer Science at Simpson College in Iowa. He created the library
37+
to teach his students how to program games in Python. The first public pre-release
38+
was in March 2016.
39+
40+
There is no question the focus of the library is on education. It's designed to
41+
be easy to use and to teach programming concepts.
42+
43+
The library has grown since then and is now used by people all over the world.
44+
The library is mostly used in schools and by hobbyists, but have also been used in
45+
various other settings such as visualization, simulation and prototyping. As the
46+
library grows it's starting to be used in more professional settings as well.
47+
48+
Notable Releases
49+
50+
* First public pre-release in March 2016
51+
* First stable release 1.x in May November 2016
52+
* 2.0 release in 2019
53+
* 2.4 release in 2020
54+
* 2.6 release in 2021 through 2022
55+
* 3.0 release in 2024

‎doc/community/community_locations.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. include:: /links.rst
2+
3+
.. _community-locations:
4+
5+
Community Locations
6+
===================
7+
8+
Most of the community interaction happens on the `Arcade Discord`_ and `Arcade Github`_.
9+
The discord server is the best place to ask questions and get help.
10+
We have help channels, various topic channels, and a place to share
11+
your projects. This is also where most of the development discussion
12+
happens.
13+
14+
Less active places (as of Summer 2024):
15+
16+
* `Reddit`_
17+
* `Twitter`_
18+
19+
Note that these communities have people of all ages from all around the
20+
world. Please be respectful and kind to everyone. Assume good intentions
21+
and be patient with people who are learning.

doc/games/game_jam_2020.rst renamed to doc/community/games/game_jam_2020.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Python Discord GameJam 2020
66
===========================
77

8-
.. image:: images/game_jam_2020.png
8+
.. image:: /images/community/games/game_jam_2020.png
99

1010
The `Python Discord <https://pythondiscord.com/>`_ 2020 Game Jam finished on
1111
April 26, 2020. Participants completed a game in one week. Twenty-three teams
@@ -25,7 +25,7 @@ This is a game where the player controls 3 different characters which need to ju
2525
Check out the
2626
`source code <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/Score_AAA>`__.
2727

28-
.. figure:: https://raw.githubusercontent.com/python-discord/game-jam-2020/master/Finalists/Score_AAA/ressources/Screenshot_full.png
28+
.. figure:: /images/community/games/3_keys_on_the_run.png
2929
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/Score_AAA
3030
:width: 45%
3131

@@ -40,7 +40,7 @@ the game together nicely. The graphics in this game were quite beautiful and the
4040
it well. Check out the
4141
`source code <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/gamer_gang>`__.
4242

43-
.. figure:: images/gamer_gang.png
43+
.. figure:: /images/community/games/gamer_gang.png
4444
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/gamer_gang
4545
:width: 45%
4646

@@ -59,7 +59,7 @@ Hatchlings
5959

6060
Honourable Mention: `Hatchlings <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/KTGames>`_
6161

62-
.. figure:: https://raw.githubusercontent.com/python-discord/game-jam-2020/master/Finalists/KTGames/rd_images/OpeningScreen.png
62+
.. figure:: /images/community/games/hatchlings.png
6363
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/KTGames
6464
:width: 45%
6565

@@ -68,7 +68,7 @@ Gem Matcher
6868

6969
Honourable Mention: `Gem Matcher <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/artemis>`_
7070

71-
.. figure:: https://raw.githubusercontent.com/python-discord/game-jam-2020/master/Finalists/artemis/assets/tutorial.gif
71+
.. figure:: /images/community/games/gem_matcher.gif
7272
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/artemis
7373
:width: 45%
7474

@@ -78,7 +78,7 @@ Tri-Chess
7878

7979
Honourable Mention: `Tri-Chess <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/TriChess>`_
8080

81-
.. figure:: https://raw.githubusercontent.com/python-discord/game-jam-2020/master/Finalists/TriChess/assets/hex_board.PNG
81+
.. figure:: /images/community/games/tri-chess.png
8282
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/TriChess
8383
:width: 45%
8484

@@ -87,7 +87,7 @@ Insane Irradiated Insectz
8787

8888
Honourable Mention: `Insane Irradiated Insectz <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/beanoculars>`_
8989

90-
.. figure:: https://raw.githubusercontent.com/python-discord/game-jam-2020/master/Finalists/beanoculars/submission/images/screen1.png
90+
.. figure:: /images/community/games/insane.png
9191
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/beanoculars
9292
:width: 45%
9393

@@ -96,7 +96,7 @@ Flimsy Billy's Coin Dash 3
9696

9797
Honourable Mention: `Flimsy Billy's Coin Dash 3: Super Tag 3 Electric Tree <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/the-friendly-snakes>`_
9898

99-
.. figure:: images/friendly_snakes.png
99+
.. figure:: /images/community/games/friendly_snakes.png
100100
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/the-friendly-snakes
101101
:width: 45%
102102

@@ -105,7 +105,7 @@ ZeYoughEzh
105105

106106
Honourable Mention: `ZeYoughEzh <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/zeyoghezh>`_
107107

108-
.. figure:: images/zeyoghezh.png
108+
.. figure:: /images/community/games/zeyoghezh.png
109109
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/zeyoghezh
110110
:width: 45%
111111

@@ -115,6 +115,6 @@ Coin Collector
115115

116116
Honourable Mention: `Coin Collector <https://github.com/python-discord/game-jam-2020/tree/master/Finalists/AtieP>`_
117117

118-
.. figure:: images/atie.png
118+
.. figure:: /images/community/games/atie.png
119119
:target: https://github.com/python-discord/game-jam-2020/tree/master/Finalists/AtieP
120120
:width: 45%

doc/games/index.rst renamed to doc/community/games/index.rst

File renamed without changes.

doc/games/sample_games.rst renamed to doc/community/games/sample_games.rst

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You also might want to check out sample Arcade games from:
1616
Brazier
1717
~~~~~~~
1818

19-
.. image:: https://img.itch.zone/aW1nLzE2NDkzMDIyLnBuZw==/315x250%23c/2l4Uej.png
19+
.. image:: /images/community/games/brazier.png
2020
:width: 400px
2121

2222
- [Itch page](https://dragonmoffon.itch.io/brazier)
@@ -25,7 +25,7 @@ Brazier
2525
PhotoShip
2626
~~~~~~~~~
2727

28-
.. image:: https://img.itch.zone/aW1hZ2UvMjc2NDUxOC8xNjQ5MjYwOC5wbmc=/794x1000/aPyjik.png
28+
.. image:: /images/community/games/photoship.png
2929
:width: 400px
3030

3131
- [Itch page](https://clodon.itch.io/photoship)
@@ -37,7 +37,7 @@ Space Station Builder
3737

3838
Build your own space station!
3939

40-
.. image:: https://img.itch.zone/aW1hZ2UvMjY5NTk3NC8xNjA3MTA2Ni5naWY=/794x1000/ONUlqh.gif
40+
.. image:: /images/community/games/space_station_builder.gif
4141
:width: 500px
4242

4343
Download at [Kosmolonia on itch.io](https://aliskda.itch.io/kosmolonia).
@@ -47,15 +47,15 @@ Notepad Doodles
4747

4848
Survive waves of monsters!
4949

50-
.. image:: https://img.itch.zone/aW1hZ2UvMjYxOTIxOS8xNjE5MTMxMi5wbmc=/original/dGbRh5.png
50+
.. image:: /images/community/games/notepad_doodles.png
5151
:width: 400px
5252

5353
Download at [Notepad Doodles on itch.io](https://arkturdev.itch.io/notepad-doodles).
5454

5555
BoxHead Survivor
5656
~~~~~~~~~~~~~~~~
5757

58-
.. image:: https://img.itch.zone/aW1hZ2UvMjM1MTM4Mi8xMzkyODQ1Ni5qcGc=/original/YI7uLX.jpg
58+
.. image:: /images/community/games/boxhead_survivor.jpg
5959
:width: 560px
6060

6161
A top-down 2D shooter game.
@@ -95,7 +95,7 @@ Binary Defense
9595
Space Invaders
9696
~~~~~~~~~~~~~~
9797

98-
.. image:: https://github.com/pvcraven/space_invaders/raw/main/screenshot.png
98+
.. image:: /images/community/games/space_invaders.png
9999
:width: 560px
100100

101101
`Space Invaders <https://github.com/pvcraven/space_invaders>`_
@@ -113,8 +113,7 @@ RPG by Akash S Panickar.
113113
Age of Divisiveness
114114
~~~~~~~~~~~~~~~~~~~
115115

116-
117-
.. image:: https://raw.githubusercontent.com/chceswieta/age-of-divisiveness/main/resources/promo/city_build.gif
116+
.. image:: /images/community/games/age_of_divisiveness.gif
118117
:width: 75%
119118

120119
`Age of Divisiveness <https://github.com/chceswieta/age-of-divisiveness>`_ by
@@ -126,7 +125,7 @@ Very extensive.
126125
Fishy-Game
127126
~~~~~~~~~~
128127

129-
.. image:: https://raw.githubusercontent.com/LiorAvrahami/fishy-game/main/example%20image.png
128+
.. image:: /images/community/games/fishy-game.png
130129
:width: 75%
131130

132131
`Fishy Game <https://github.com/LiorAvrahami/fishy-game>`_ by LiorAvrahami
@@ -143,7 +142,7 @@ Adventure
143142
Transcience Animation
144143
~~~~~~~~~~~~~~~~~~~~~
145144

146-
.. image:: https://raw.githubusercontent.com/SunTzunami/Transience_animation_PyArcade/master/Demo/preview.gif
145+
.. image:: /images/community/games/transcience.gif
147146
:width: 75%
148147

149148
`Transcience Animation <https://github.com/SunTzunami/Transience_animation_PyArcade>`_
@@ -161,15 +160,15 @@ Stellar Arena Demo
161160
Battle Bros
162161
~~~~~~~~~~~
163162

164-
.. image:: https://raw.githubusercontent.com/njbittner/battle-bros-pyarcade/master/battlebros.gif
163+
.. image:: /images/community/games/battlebros.gif
165164
:width: 50%
166165

167166
`Battle Bros <https://github.com/njbittner/battle-bros-pyarcade>`_ Mortal Kombat style game.
168167

169168
Rabbit Herder
170169
~~~~~~~~~~~~~
171170

172-
.. image:: https://raw.githubusercontent.com/ryancollingwood/arcade-rabbit-herder/master/resources/static/preview.gif
171+
.. image:: /images/community/games/rabbit_herder.gif
173172
:width: 50%
174173

175174
`Rabbit Herder <https://github.com/ryancollingwood/arcade-rabbit-herder>`_,
@@ -189,46 +188,46 @@ The Great Skeleton War
189188
Python Knife Hit
190189
~~~~~~~~~~~~~~~~
191190

192-
.. figure:: images/python_knife_hit.png
191+
.. figure:: /images/community/games/python_knife_hit.png
193192
:width: 50%
194193

195194
https://github.com/akmalhakimi1991/python-knife-hit
196195

197196
Kayzee
198197
~~~~~~
199198

200-
.. figure:: images/kayzee.png
199+
.. figure:: /images/community/games/kayzee.png
201200
:width: 50%
202201

203202
`Kayzee Game <https://github.com/wamiqurrehman093/Kayzee>`_
204203

205204
lixingqiu Games
206205
~~~~~~~~~~~~~~~
207206

208-
.. figure:: images/eight_planet.gif
207+
.. figure:: /images/community/games/eight_planet.gif
209208
:width: 50%
210209

211210
An `Eight planet simulation <https://github.com/lixingqiu/eight_planet>`_
212211

213-
.. figure:: images/midway.png
212+
.. figure:: /images/community/games/midway.png
214213
:width: 50%
215214

216215
`Midway Island War <https://github.com/lixingqiu/python3_arcade_midway_island_war_simple_simulate>`_
217216

218-
.. figure:: images/angry_bird.gif
217+
.. figure:: /images/community/games/angry_bird.gif
219218
:width: 50%
220219

221220
`Angry Bird <https://github.com/lixingqiu/python_arcade_simple_angry_bird>`_
222221

223-
.. figure:: images/octopus.gif
222+
.. figure:: /images/community/games/octopus.gif
224223
:width: 50%
225224

226225
`Octopus <https://github.com/lixingqiu/Python-arcade-Octopus-animation-demo>`_
227226

228227
Space Typer
229228
~~~~~~~~~~~
230229

231-
.. image:: images/space_typer.png
230+
.. image:: /images/community/games/space_typer.png
232231
:width: 75%
233232

234233
`Space Typer`_ - A typing game
@@ -239,7 +238,8 @@ Space Typer
239238
FlapPy Bird
240239
~~~~~~~~~~~
241240

242-
.. image:: https://camo.githubusercontent.com/b373859d570155b72030f36ae7ece8b9575bda6d45eb0695f5a060d3dfa27dab/68747470733a2f2f692e706f7374696d672e63632f665678394b736b672f53637265656e5f53686f745f323031382d30392d32375f61745f31322e31312e31395f414d2e706e67
241+
.. image:: /images/community/games/flappy.png
242+
:width: 25%
243243

244244
`FlapPy-Bird`_ - A bird-game clone.
245245

@@ -251,7 +251,7 @@ FlapPy Bird
251251
PyOverheadGame
252252
~~~~~~~~~~~~~~
253253

254-
.. image:: images/PyOverheadGame.png
254+
.. image:: /images/community/games/PyOverheadGame.png
255255
:width: 75%
256256

257257
PyOverheadGame_, a 2D overhead game where you go through several rooms and pick up keys and other objects.
@@ -262,7 +262,7 @@ PyOverheadGame_, a 2D overhead game where you go through several rooms and pick
262262
Dungeon
263263
~~~~~~~
264264

265-
.. image:: images/blake.png
265+
.. image:: /images/community/games/blake.png
266266
:width: 75%
267267

268268
Dungeon_, explore a maze picking up arrows and coins.
@@ -272,15 +272,15 @@ Dungeon_, explore a maze picking up arrows and coins.
272272
Two Worlds
273273
~~~~~~~~~~
274274

275-
.. image:: https://camo.githubusercontent.com/a74f38285980087502aec7795e10bec5869e71c840a35729fa37edf6ad17858d/68747470733a2f2f696d6775722e636f6d2f634372674171712e706e67
275+
.. image:: /images/community/games/two_worlds.png
276276
:width: 75%
277277

278278
`Two Worlds`_, a castle adventure with a dungeon and caverns underneath it.
279279

280280
.. _Two Worlds: https://github.com/pvcraven/two_worlds
281281

282282
Simpson College Spring 2017 CMSC 150 Course
283-
-------------------------------------------
283+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
284284

285285
These games were created by first-semester programming students.
286286

0 commit comments

Comments
 (0)