How to Write a Server - Revision history

imported>LassiPulkkinen: Very out of date.

2024-03-19T14:18:17Z

Very out of date.

← Older revision		Revision as of 14:18, 19 March 2024
Line 1:		Line 1:
	This tutorial is being created to document what it takes to write a stand-alone server to interact with Notchian clients. The tutorial is incomplete but will be updated whenever more information is discovered.		This tutorial is being created to document what it takes to write a stand-alone server to interact with Notchian clients. The tutorial is incomplete but will be updated whenever more information is discovered.

			'''Note that a lot of the information here is out of date (last updated in 2016), especially as a result of recent changes in 1.20.2. You should probably look elsewhere instead, e.g. the [[Protocol FAQ]].'''

	== Before You Get Started ==		== Before You Get Started ==

imported>LassiPulkkinen: Add Category:Minecraft Modern.

2024-02-26T19:00:56Z

Add Category:Minecraft Modern.

← Older revision		Revision as of 19:00, 26 February 2024
Line 28:		Line 28:

	It should be noted that outgoing packets are not directed towards the ''TCP'' node in the middle. This is just because it made a simpler FSM. There is also a possibility to have the [[Protocol#Set_compression\|Set compression]] to be sent after [[Protocol#Login_success\|Login success]], but it will have a different packet id because the connection state will be [[Protocol#Play\|Play]] instead of [[Protocol#Login\|Login]].		It should be noted that outgoing packets are not directed towards the ''TCP'' node in the middle. This is just because it made a simpler FSM. There is also a possibility to have the [[Protocol#Set_compression\|Set compression]] to be sent after [[Protocol#Login_success\|Login success]], but it will have a different packet id because the connection state will be [[Protocol#Play\|Play]] instead of [[Protocol#Login\|Login]].

			[[Category:Minecraft Modern]]

imported>Pokechu22: Link format cleanup

2016-03-03T16:35:48Z

Link format cleanup

← Older revision		Revision as of 16:35, 3 March 2016
Line 2:		Line 2:

	== Before You Get Started ==		== Before You Get Started ==
	* Make sure you don't want to fork or join an [[~~Server_List~~\|existing project]].		* Make sure you don't want to fork or join an [[Server List\|existing project]].
	* Wonder why you want to do this in the first place.		* Wonder why you want to do this in the first place.
	* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)		* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)
Line 16:		Line 16:

	=== FSM example of handling new TCP connections ===		=== FSM example of handling new TCP connections ===
	As an example of how to handle new TCP connections we can have a look at this informal [~~http~~:~~//en.wikipedia.org/wiki/~~Finite-~~state_machine~~\| FSM] to get an example of how one could write the server's states.		As an example of how to handle new TCP connections we can have a look at this informal [[Wikipedia:Finite-state machine\|FSM]] to get an example of how one could write the server's states.

	[[File:Server TCP handling HSL.png\|800px\| FSM showing an example of how to handle new connections]]		[[File:Server TCP handling HSL.png\|800px\|FSM showing an example of how to handle new connections]]

	To distinguish between FSM-states and the states of the connection, the different connection states has been colour-coded to make it easier to understand the transitions. The given connection states are:		To distinguish between FSM-states and the states of the connection, the different connection states has been colour-coded to make it easier to understand the transitions. The given connection states are:
Line 25:		Line 25:
	* Login		* Login
	* Play		* Play
	* Closed (added for clarity, as [[Protocol#Pong\| Pong]] closed the TCP socket)		* Closed (added for clarity, as [[Protocol#Pong\|Pong]] closed the TCP socket)

	It should be noted that outgoing packets are not directed towards the ''TCP'' node in the middle. This is just because it made a simpler FSM. There is also a possibility to have the [[Protocol#Set_compression]\| Set compression] to be sent after [[Protocol#Login_success]\| Login success], but it will have a different packet id because the connection state will be [[Protocol#Play\| Play]] instead of [[Protocol#Login\| Login]].		It should be noted that outgoing packets are not directed towards the ''TCP'' node in the middle. This is just because it made a simpler FSM. There is also a possibility to have the [[Protocol#Set_compression\|Set compression]] to be sent after [[Protocol#Login_success\|Login success]], but it will have a different packet id because the connection state will be [[Protocol#Play\|Play]] instead of [[Protocol#Login\|Login]].

imported>Menuan: Added an example of how to handle the first parts of a new TCP connection.

2015-11-10T14:44:37Z

Added an example of how to handle the first parts of a new TCP connection.

← Older revision		Revision as of 14:44, 10 November 2015
Line 14:		Line 14:
	== [[Server List Ping]] ==		== [[Server List Ping]] ==
	Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can read more about this on the [[Server List Ping]] page.		Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can read more about this on the [[Server List Ping]] page.

			=== FSM example of handling new TCP connections ===
			As an example of how to handle new TCP connections we can have a look at this informal [http://en.wikipedia.org/wiki/Finite-state_machine\| FSM] to get an example of how one could write the server's states.

			[[File:Server TCP handling HSL.png\|800px\| FSM showing an example of how to handle new connections]]

			To distinguish between FSM-states and the states of the connection, the different connection states has been colour-coded to make it easier to understand the transitions. The given connection states are:
			* Handshake
			* Status
			* Login
			* Play
			* Closed (added for clarity, as [[Protocol#Pong\| Pong]] closed the TCP socket)

			It should be noted that outgoing packets are not directed towards the ''TCP'' node in the middle. This is just because it made a simpler FSM. There is also a possibility to have the [[Protocol#Set_compression]\| Set compression] to be sent after [[Protocol#Login_success]\| Login success], but it will have a different packet id because the connection state will be [[Protocol#Play\| Play]] instead of [[Protocol#Login\| Login]].

imported>Menuan: /* Server List Ping */

2015-11-09T19:12:43Z

Server List Ping

← Older revision		Revision as of 19:12, 9 November 2015
Line 13:		Line 13:

	== [[Server List Ping]] ==		== [[Server List Ping]] ==
	Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can ~~rad~~ more about this on the [[Server List Ping]] page.		Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can read more about this on the [[Server List Ping]] page.

imported>Gjum: /* Before You Get Started */ Link to Server_List for existing projects

2015-11-05T18:08:38Z

Before You Get Started: Link to Server_List for existing projects

← Older revision		Revision as of 18:08, 5 November 2015
Line 2:		Line 2:

	== Before You Get Started ==		== Before You Get Started ==
	* Make sure you don't want to fork or join an existing project.		* Make sure you don't want to fork or join an [[Server_List\|existing project]].
	* Wonder why you want to do this in the first place.		* Wonder why you want to do this in the first place.
	* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)		* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)

imported>Pokechu22: Fix broken internal links

2015-10-26T16:22:38Z

Fix broken internal links

← Older revision		Revision as of 16:22, 26 October 2015
Line 10:		Line 10:

	=== Accepting TCP Packets ===		=== Accepting TCP Packets ===
	The Minecraft server accepts connections from TCP clients and communicates with them using ''packets''. A packet is a sequence of bytes sent over the TCP connection. The meaning of a packet depends both on its packet ID and the current state of the connection. The initial state of each connection is [[Protocol#Handshaking\|Handshaking]], and state is switched using the packets [[Protocol#Handshake\|Handshake]] ([[Protocol#Handshaking\|Handshaking]], 0x00, serverbound) and [[Protocol#Login Success\|Login Success]] ([[Protocol#Login\|Login]], 0x02, clientbound). You can read more about Minecraft Packets on the [Protocol\|Protocol page].		The Minecraft server accepts connections from TCP clients and communicates with them using ''packets''. A packet is a sequence of bytes sent over the TCP connection. The meaning of a packet depends both on its packet ID and the current state of the connection. The initial state of each connection is [[Protocol#Handshaking\|Handshaking]], and state is switched using the packets [[Protocol#Handshake\|Handshake]] ([[Protocol#Handshaking\|Handshaking]], 0x00, serverbound) and [[Protocol#Login Success\|Login Success]] ([[Protocol#Login\|Login]], 0x02, clientbound). You can read more about Minecraft Packets on the [[Protocol\|Protocol page]].

	== [Server List Ping] ==		== [[Server List Ping]] ==
	Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can rad more about this on the [Server List Ping] page.		Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can rad more about this on the [[Server List Ping]] page.

imported>Phasesaber: Explain TCP connections

2015-10-21T02:07:15Z

Explain TCP connections

← Older revision		Revision as of 02:07, 21 October 2015
Line 5:		Line 5:
	* Wonder why you want to do this in the first place.		* Wonder why you want to do this in the first place.
	* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)		* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)

			== If you're not using a wrapper/library ==
			If you're not using a wrapper/library, then you'll need to do all the dirty work by hand.

			=== Accepting TCP Packets ===
			The Minecraft server accepts connections from TCP clients and communicates with them using ''packets''. A packet is a sequence of bytes sent over the TCP connection. The meaning of a packet depends both on its packet ID and the current state of the connection. The initial state of each connection is [[Protocol#Handshaking\|Handshaking]], and state is switched using the packets [[Protocol#Handshake\|Handshake]] ([[Protocol#Handshaking\|Handshaking]], 0x00, serverbound) and [[Protocol#Login Success\|Login Success]] ([[Protocol#Login\|Login]], 0x02, clientbound). You can read more about Minecraft Packets on the [Protocol\|Protocol page].

			== [Server List Ping] ==
			Your server needs to accept a Handshake(0x00 with state=1) and a Request packet, which you'll respond with a Response packet including JSON detailing the server. You can rad more about this on the [Server List Ping] page.

imported>Phasesaber: Kickstart this tutorial

2015-10-21T01:43:12Z

Kickstart this tutorial

New page

This tutorial is being created to document what it takes to write a stand-alone server to interact with Notchian clients. The tutorial is incomplete but will be updated whenever more information is discovered.

== Before You Get Started ==
* Make sure you don't want to fork or join an existing project.
* Wonder why you want to do this in the first place.
* Choose a language that has good networking, like Java, C#, or Python. (If you want to be different, choose a faster language like C or Rust!)