/
README.md
142 lines (103 loc) · 6.2 KB
/
README.md
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
# X-Moto 0.6.2 [](https://github.com/xmoto/xmoto/actions/) [](https://sonarcloud.io/dashboard?id=xmoto_xmoto) [](https://discord.gg/W33yTUd)
Copyright (C) 2005-2023
# Introduction
[X-Moto Website](https://xmoto.tuxfamily.org)
X-Moto is a challenging 2D motocross platform game, where physics play
an all important role in the gameplay. You need to control your bike to
its limit, if you want to have a chance finishing the more difficult of
the challenges.
First you'll try just to complete the levels, while later you'll compete
with yourself and others, racing against the clock.
# Installation
Download and install the game from https://xmoto.tuxfamily.org
# Building
See the wiki:
- [Windows](https://github.com/xmoto/xmoto/wiki/Building-on-Windows)
- [Linux](https://github.com/xmoto/xmoto/wiki/Building-on-Linux)
- [macOS](https://github.com/xmoto/xmoto/wiki/Building-on-macOS)
- [FreeBSD](https://github.com/xmoto/xmoto/wiki/Building-on-FreeBSD)
# Basic Gameplay
A number of strawberries are spread around each level, which generally
consists of a complicated landscape seen from the side - i.e. much like
islands in the sky. You need to collect all these berries to
complete the level - when you've got the last one, you should find
the sunflower which will complete the level when you touch it.
Variations to this basic gameplay may be found around some of the
levels.
Your motocross bike is likewise seen from the side,
and you control its throttle, braking, and simple changes to the
attitude by jerking the bike back and forth. Additionally you can change
the direction of your driving, by rotating on the spot.
# Controls
You control your bike using the keyboard:
- Up arrow - Accelerates
- Down arrow - Brakes
- Left arrow - Rotates it counter-clockwise
- Right arrow - Rotates it clockwise
- Space - Turns around and drives in the other direction
Note that the above keys can be configured to something else to suit
your needs.
Additionally, some other keys can be pressed while playing:
- Escape - Pauses the game, and opens the in-game menu
- F12 - Takes a screenshot (saved in the ``~/.local/share/xmoto`` directory)
# Command-line Options
X-Moto supports a range of options you can specify on the command
line when starting the program. Run ``xmoto --help`` to get details on these options.
# Letting X-Moto Access The Web
X-Moto comes with a feature that allows
the game to connect to the web and download high-scores (world
records) and extra levels.
The first time you run X-Moto you'll be asked about whether you want
to allow the game to access your Internet connection; if you don't
have one, simply click "No". Then you'll be asked to specify your
proxy settings. X-Moto supports HTTP proxies, SOCKS4 proxies, and
SOCKS5 proxies. If you're behind a firewall, you most likely need to
specify a proxy; ask your network administrator for guidance if
you're in doubt.
# Replays
X-Moto supports recording and playback of
replays. These are always stored in the ``Replays/`` directory, which is
located in the ``.local/share/xmoto`` in the user directory.
One should be aware that replays can take up quite a large amount of
harddisk space - on average you can expect a single minute of replay
to equal around 50 kilobytes. If you want to disable recording of
replays, you can set the ``StoreReplays`` variable to ``false`` in
``config.dat``, which is located in ``~/.local/share/xmoto``.
Other things to be aware of regarding X-Moto replays:
- Due to the way they are stored, they seem a bit less smooth
than the actual game.
- No fancy dirt particles from rear wheel spinning.
# Advanced Configuration Options
Options are saved in a file called ``config.dat``. The file is saved
in ``~/.config/xmoto``.
It is a plain XML text file, so it should be straight-forward to modify
in any text editor. In addition to the options accessible from inside
the game, there's a couple more, which is not interesting enough to
get included in the menus:
- WebHighscoresURL
> The URL from which public high-scores should be downloaded. Please consult the high-scores website for information about how this is used to make your own "private" high-score lists.
- WebLevelsURL
> Place on the web to look for extra levels.
- DefaultProfile
> Specifies which player profile should be active when the game starts.
- ScreenshotFormat
> The format in which screenshots should be saved in. Can be either jpg or png.
- StoreReplays
> If true, replays will be automatically recorded during the game. When the player dies or finishes the level, he can then choose to save the replay. If set to false, no replay saving will be possible. Recording replays have a theoretical impact on the framerate of the game, but practically you shouldn't be able to notice anything.
- ReplayFrameRate
> Specifies the framerate at which replays will be recorded at. The higher it is, the smoother the replay will seem to be, but it will also cause the replay file to be much larger. Never set this option to higher values than 50, as it could cause unforeseen consequenses. The default value of 25 seems to be a good compromise between smoothness and file size.
# Bugs
If you experiences any bugs, please open [a new issue](https://github.com/xmoto/xmoto/issues)
# License
The game and its source code is released under the terms of the GNU
General Public License. See COPYING for details.
Some of the source code originating from various third parties is not
released under the same license. Please consult the appropriate
license material for more information.
Generally you're free to copy and reproduce both X-Moto and the
source code in any way you like, even to modify the source and release
your own version of the game, as long as you comply with the
above mentioned licenses.
### Authors
See the in-game credits under "Help".