You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Freeciv-web is an open-source turn-based strategy game. It can be played in any HTML5 capable web-browser and features in-depth game-play and a wide variety of game modes and options. Your goal is to build cities, collect resources, organize your government, and build an army, with the ultimate goal of creating the best civilization. You can play online against other players (multiplayer) or play by yourself against the computer. There is both a HTML5 2D version with isometric graphics and a 3D WebGL version of Freeciv-web.
9
+
Freeciv-web is an open-source turn-based strategy game. It can be played in any HTML5 capable web-browser and features in-depth game-play and a wide variety of game modes and options. Your goal is to build cities, collect resources, organize your government, and build an army, with the ultimate goal of creating the best civilization. You can play online against other players (multiplayer) or play by yourself against the computer. There is both a HTML5 2D version with isometric graphics and a 3D WebGL version of Freeciv-web.
10
10
11
11
Freeciv-web is free and open source software. The Freeciv C server is released under the GNU General Public License, while the Freeciv-web client is released
12
12
under the GNU Affero General Public License. See [License](LICENSE.txt) for the full license document.
@@ -37,27 +37,27 @@ Freeciv-Web consists of these components:
37
37
*[Freeciv-web](freeciv-web) - a Java web application for the Freeciv-web client.
38
38
This application is a Java web application which make up the application
39
39
viewed in each user's web browser. The Metaserver is also a part of this module.
40
-
Implemented in Javascript, Java, JSP, HTML and CSS. Built with maven and runs
40
+
Implemented in Javascript, Java, JSP, HTML and CSS. Built with maven and runs
41
41
on Tomcat 10 and nginx.
42
42
43
43
*[Freeciv](freeciv) - the Freeciv C server, which is checked out from the official
44
44
Git repository, and patched to work with a WebSocket/JSON protocol. Implemented in C.
45
45
46
46
*[Freeciv-proxy](freeciv-proxy) - a WebSocket proxy which allows WebSocket clients in Freeciv-web
47
-
to send socket requests to Freeciv servers. WebSocket requests are sent from Javascript
48
-
in Freeciv-web to nginx, which then proxies the WebSocket messages to freeciv-proxy,
47
+
to send socket requests to Freeciv servers. WebSocket requests are sent from Javascript
48
+
in Freeciv-web to nginx, which then proxies the WebSocket messages to freeciv-proxy,
49
49
which finally sends Freeciv socket requests to the Freeciv servers. Implemented in Python.
50
50
51
51
*[Publite2](publite2) - a process launcher for Freeciv C servers, which manages
52
-
multiple Freeciv server processes and checks capacity through the Metaserver.
52
+
multiple Freeciv server processes and checks capacity through the Metaserver.
53
53
Implemented in Python.
54
54
55
-
*[pbem](pbem) is play-by-email support.
55
+
*[pbem](pbem) is play-by-email support.
56
56
57
57
Freeciv WebGL
58
58
-------------
59
59
Freeciv WebGL is the 3D version, which uses the Three.js 3D engine. More info about the WebGL 3D version can be found for [developers](https://github.com/freeciv/freeciv-web/tree/develop/freeciv-web/src/main/webapp/javascript/webgl) and [3D artists](https://github.com/freeciv/freeciv-web/wiki/Contributing-Blender-models-for-Freeciv-WebGL).
60
-
Developer: Andreas Røsdal [@andreasrosdal](http://www.twitter.com/andreasrosdal)
60
+
Developer: Andreas Røsdal [@andreasrosdal](http://www.twitter.com/andreasrosdal)
61
61
62
62
Running Freeciv-web on your computer
63
63
------------------------------------
@@ -88,9 +88,9 @@ like dos2unix after saving them.
88
88
89
89
### Running Freeciv-web with Vagrant on VirtualBox
90
90
91
-
Freeciv-web can be setup using Vagrant on VirtualBox to quickly create a
91
+
Freeciv-web can be setup using Vagrant on VirtualBox to quickly create a
92
92
local developer image running Freeciv-web on latest Ubuntu on your host
93
-
operating system such as Windows, OSX or Linux.
93
+
operating system such as Windows, OSX or Linux.
94
94
This is the recommended way to build Freeciv-web on your computer.
95
95
96
96
1. Install VirtualBox: https://www.virtualbox.org/ - Install manually on Windows, and with the following command on Linux:
@@ -113,7 +113,7 @@ sudo apt-get install vagrant
113
113
114
114
4. Test Freeciv-web by pointing your browser to http://localhost if you run Windows or http://localhost:8080 if you run Linux or macOS.
115
115
116
-
To log in to your Vagrant server, run the command:
116
+
To log in to your Vagrant server, run the command:
117
117
```bash
118
118
vagrant ssh
119
119
```
@@ -128,7 +128,7 @@ Install this software if you are not running Freeciv-web with Vagrant:
128
128
129
129
- Tomcat 10 - https://tomcat.apache.org/
130
130
131
-
- Java 11 JDK - https://adoptopenjdk.net/
131
+
- Java 11 JDK - https://adoptopenjdk.net/
132
132
133
133
- Python 3.6 - http://www.python.org/
134
134
@@ -161,9 +161,9 @@ Install this software if you are not running Freeciv-web with Vagrant:
161
161
When in a [tested system](scripts/install/systems),
162
162
you may run `scripts/install/install.sh` and it will fetch and configure what's needed.
163
163
164
-
Start and stop Freeciv-web with the following commands:
165
-
start-freeciv-web.sh
166
-
stop-freeciv-web.sh
164
+
Start and stop Freeciv-web with the following commands:
165
+
start-freeciv-web.sh
166
+
stop-freeciv-web.sh
167
167
status-freeciv-web.sh
168
168
169
169
All software components in Freeciv-web will log to the /logs sub-directory of the Freeciv-web installation.
@@ -196,16 +196,16 @@ Freeciv-Web is built on GitHub actions on every commit. This is the current buil
196
196
Developers interested in Freeciv-web
197
197
------------------------------------
198
198
199
-
If you want to contibute to Freeciv-web, see the [issues](https://github.com/freeciv/freeciv-web/issues) on GibHub and the [TODO file](doc/TODO) for
200
-
some tasks you can work on. Pull requests on Github is welcome!
201
-
199
+
If you want to contibute to Freeciv-web, see the [issues](https://github.com/freeciv/freeciv-web/issues) on GibHub and the [TODO file](doc/TODO) for
200
+
some tasks you can work on. Pull requests on Github are welcome!
201
+
202
202
203
203
Contributors to Freeciv-web
204
204
---------------------------
205
-
Andreas Røsdal [@andreasrosdal](https://github.com/andreasrosdal)
206
-
Marko Lindqvist [@cazfi](https://github.com/cazfi)
Copy file name to clipboardExpand all lines: doc/CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,18 @@ Thank you for your interest in contributing to Freeciv-web!
6
6
7
7
Freeciv is an open source project where contributions from the open source community is encouraged.
8
8
There are multiple versions of Freeciv-web, and Freeciv-web can be hosted on multiple server instances.
9
-
To get involved in one of these Freeciv-web instances, you may either contribute directly to the
9
+
To get involved in one of these Freeciv-web instances, you may either contribute directly to the
10
10
github.com/freeciv/freeciv-web repository by submitting a pull-request there, or contact one of the fork projects
11
11
of Freeciv-web on GitHub, IRC, e-mailing lists, Discord or similar.
12
12
13
13
## Multiple Freeciv-web servers
14
-
We need to recognize that there are multiple competing Freeciv-web servers, and that the main
15
-
freeciv/freeciv-web github repository must be generic and not specific to one site.
14
+
We need to recognize that there are multiple competing Freeciv-web servers, and that the main
15
+
freeciv/freeciv-web github repository must be generic and not specific to one site.
16
16
We will get a better Freeciv-web service if we allow multiple servers to exists and compete.
17
17
18
18
## Pull Request Guidelines
19
19
20
-
- All changes to Freeciv-web must be done using Pull Requests on GitHub. Don't commit changes directly to the master or develop branch.
20
+
- All changes to Freeciv-web must be done using Pull Requests on GitHub. Don't commit changes directly to the master or develop branch.
21
21
- Pull requests must be approved by two other Freeciv developers. Minor changes can be approved by one Freeciv developer. If there's no objections within 72h to the pull request, it's ok to merge it.
22
22
- Only freeciv maintainers team members have rights to merge commits.
23
23
- Don't break the build. All tests run by GitHub actions must pass successfully.
0 commit comments