Difference between revisions of "Private Server Installation"

From Screeps Wiki
Jump to navigation Jump to search
m
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
[[Category:Private Server]]
 +
[[Category:Private Server|Installation]]
⚫
For the most up to date instructions and requirements, visit GitHub[https://github.com/screeps/screeps]
  
   
  +
This guide will help you get started with installing a Screeps [[Private Server|Private Server]].
⚫
= Requirements =
  
   
  +
== Community Solutions ==
−
* 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 (for node-gyp, Python 3 is not supported [https://github.com/nodejs/node-gyp/issues/193])
  
   
  +
These are the community-preferred solutions for hosting a private server.
⚫
= Installation =
  
   
  +
=== Screepers Launcher ===
−
In an empty folder:
  
   
  +
[https://github.com/screepers/screeps-launcher Screepers Launcher] is developed by the community to streamline the launch process and offer additional features for managing the private server.
⚫
<code><pre>
  
  +
⚫
npm install -g screeps
  
  +
The recommended way to install the Screepers Launcher is to use the Docker image. This will ensure that all dependencies are met and that the server is isolated from the host system. See the [https://github.com/screepers/screeps-launcher#docker-compose Docker Install Instructions] for more information.
⚫
screeps init
  
  +
⚫
screeps start
  
  +
=== Jomik's Screeps Server ===
⚫
</pre></code>
  
  +
−
That will start a server on port 21025 by default.
  
  +
[https://github.com/Jomik/screeps-server Jomik's Screeps Server] focuses on ease of use and simplicity. It leverages Docker to provide a containerized environment, simplifying deployment and administration.
⚫
To connect to CLI, in another shell run
  
  +
⚫
<code>screeps cli</code>
  
  +
To install Jomik's Screeps Server, follow the instructions in the [https://github.com/Jomik/screeps-server/wiki/Getting-started Getting Started Guide].
  +
  +
  +
== Official Server Package ==
  +
  +
The <code>screeps</code> package on npm is the most up-to-date version of the Screeps server and is the official private server package provided by the Screeps development team. However, it is not as user-friendly as the community solutions.
  +
  ⚫
=== Requirements ===
  +
  +
* Node 10 or Node 12 (Newer versions of node will not work)
  +
* Python 2 and Python 3
  +
* Build tools (<code>apt install build-essential</code> for Debian/Ubuntu, install Visual Studio for Windows)
  +
  ⚫
=== Installation ===
  +
  +
The GUI launcher is installed along with the Screeps client through Steam.
  +
  ⚫
To install the Screeps private server without a GUI, run the following commands. This will start the server on part 21025 by default. For the most up to date instructions and requirements, visit https://github.com/screeps/screeps.
  ⚫
<pre>
  ⚫
npm install screeps
  ⚫
npx screeps init
  ⚫
npx screeps start
  ⚫
</pre>
  +
  ⚫
To connect to CLI server, in another shell run:
  ⚫
<code>npx screeps cli</code>

Latest revision as of 15:02, 21 April 2024


This guide will help you get started with installing a Screeps Private Server.

Community Solutions[edit | edit source]

These are the community-preferred solutions for hosting a private server.

Screepers Launcher[edit | edit source]

Screepers Launcher is developed by the community to streamline the launch process and offer additional features for managing the private server.

The recommended way to install the Screepers Launcher is to use the Docker image. This will ensure that all dependencies are met and that the server is isolated from the host system. See the Docker Install Instructions for more information.

Jomik's Screeps Server[edit | edit source]

Jomik's Screeps Server focuses on ease of use and simplicity. It leverages Docker to provide a containerized environment, simplifying deployment and administration.

To install Jomik's Screeps Server, follow the instructions in the Getting Started Guide.


Official Server Package[edit | edit source]

The screeps package on npm is the most up-to-date version of the Screeps server and is the official private server package provided by the Screeps development team. However, it is not as user-friendly as the community solutions.

Requirements[edit | edit source]

  • 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)

Installation[edit | edit source]

The GUI launcher is installed along with the Screeps client through Steam.

To install the Screeps private server without a GUI, run the following commands. This will start the server on part 21025 by default. For the most up to date instructions and requirements, visit https://github.com/screeps/screeps. 

npm install screeps
npx screeps init
npx screeps start

To connect to CLI server, in another shell run: 

npx screeps cli
Retrieved from "https://wiki.screepspl.us/index.php?title=Private_Server_Installation&oldid=3574"