Difference between revisions of "Private Server Installation"

Revision as of 13:57, 21 April 2024

For the most up to date instructions and requirements, visit https://github.com/screeps/screeps.

Node 10 or Node 12 (Newer versions of node will not work)
Python 2 and Python 3
Build tools (apt install build-essential for Debian/Ubuntu, install Visual Studio for Windows)

To install the Screeps private server without a GUI, run the following commands. This will start the server on part 21025 by default.

npm install screeps
npx screeps init
npx screeps start

To connect to CLI server, in another shell run:

npx screeps cli

@@ Line 1: / Line 1: @@
 [[Category:Private Server|Installation]]
-For the most up to date instructions and requirements, visit GitHub[https://github.com/screeps/screeps]
+For the most up to date instructions and requirements, visit https://github.com/screeps/screeps.
-= Requirements =
+== Requirements ==
+* Node 10 or Node 12 (Newer versions of node will not work)
-* Node.js 6 or higher (https://nodejs.org) (Avoid your distro repo, they are generally outdated, download directly or use nodesource repos instead)
+* Python 2 and Python 3
-* Python 2 (for node-gyp, Python 3 is not supported [https://github.com/nodejs/node-gyp/issues/193])
-* Debian will need the 'build-essential' package for compilers and make etc...
+* Build tools (<code>apt install build-essential</code> for Debian/Ubuntu, install Visual Studio for Windows)
-= Installation =
+== Installation ==
-In an empty folder:
+To install the Screeps private server without a GUI, run the following commands. This will start the server on part 21025 by default.
 <pre>
-npm install -g screeps
+npm install screeps
-screeps init
+npx screeps init
-screeps start
+npx screeps start
 </pre>
-That will start a server on port 21025 by default.
-To connect to CLI, in another shell run
+To connect to CLI server, in another shell run:
-<pre>screeps cli</pre>
+ <code>npx screeps cli</code>