Thread: [592] ScapeEmulator barebone

[Only registered and activated users can see links. ]

Index_gl is NOT working as for now, don't know yet why. (probably .dat4 related.) Libs come only in windows x32. I'll be looking for x64/linux/mac in mitb/oldrs.
Currently missing player updating and packet decoders, will update after i manage to learn the base a bit better.

This is the ORIGINAL ScapeEmulator, with NO bugfixes, no new features, no new nothing. Original ScapeEmulator. Auto-login protocol (protocol id in 592: 24) is NOT converted. Rest are.

Login Region packet bit-block encoding is basic, and so incomplete that it only sends raw data. Player updating has NOT been started.



EDIT:

Spoiler for Auto World converted:

Code:

package net.scapeemulator.game.net.auto;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.MessageBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ByteToMessageDecoder;
import net.scapeemulator.util.Base37Utils;
import net.scapeemulator.util.ByteBufUtils;
import net.scapeemulator.util.crypto.RsaKeySet;

import java.io.IOException;

public final class AutoLoginDecoder extends ByteToMessageDecoder {

	public enum State {
		READ_SIZE, READ_PAYLOAD;
	}

	private State state = State.READ_SIZE;
	private int size;
	private int version;

	@Override
	public void decode(ChannelHandlerContext ctx, ByteBuf buf, MessageBuf<Object> out) throws IOException {
		if (state == State.READ_SIZE) {
			if (!buf.isReadable() && buf.readableBytes() < 3)
				return;

			state = State.READ_PAYLOAD;
			size = buf.readUnsignedByte() - 2;
			version = buf.readUnsignedShort();
		}
		if (state == State.READ_PAYLOAD) {
			if (buf.readableBytes() < size)
				return;

			int encryptedSize = buf.readUnsignedByte();
			if (encryptedSize != size - 1)
				throw new IOException("Encrypted size mismatch.");

			ByteBuf secureBuffer = ByteBufUtils.rsa(buf.readBytes(encryptedSize), RsaKeySet.MODULUS,
					RsaKeySet.PRIVATE_KEY);
			int encryptedType = secureBuffer.readUnsignedByte();
			if (encryptedType != 10)
				throw new IOException("Invalid encrypted block type.");

			secureBuffer.readUnsignedInt();
			String username = Base37Utils.decodeBase37(secureBuffer.readLong());
			secureBuffer.readInt();
			String password = ByteBufUtils.readString(secureBuffer);
			secureBuffer.readInt();
			out.add(new AutoLoginRequest(version, username, password));
		}
	}

}

Also go to HandshakeMessage, and change SERVICE_AUTO_LOGIN to 24.

[Only registered and activated users can see links. ]

Spoiler for Set-up guide and original features by graham and Jonneh:

Originally Posted by Jonneh

Intro
ScapeEmulator is a RuneScape server emulator, created by myself and Graham, which targets build 530 of the game. It is written in Java 7, and can be built with Apache Maven.

It is released under the ISC license: [Only registered and activated users can see links. ]

The following third-party libraries are used:

• JUnit
• SLF4J
• APIviz
• ObjectWeb ASM
• Netty 4
• MySQL Connector/J

Download
Everything: [Only registered and activated users can see links. ]
Server code only (no cache/client etc.): [Only registered and activated users can see links. ]


Setup
A rough guide of how to get it working (on a UNIX-like system such as Linux)

1. Generate a keystore:
   
   
   Code:

   cd util/data
   ./mkkeystore

   
   
2. Compile, run unit tests and generate Javadoc:
   
   
   Code:

   mvn compile test javadoc:aggregate

   
   
3. Generate RSA key:
   
   
   Code:

   cd util
   java -cp ... net.scapeemulator.util.crypto.RsaKeyGenerator
   # then manually place the RSA key in src/main/java/net/scapeemulator/util/
   #   crypto/RsaKeySet.java

   
   
4. Recompile with the RSA key now in place:
   
   Code:

   mvn compile

   
   
5. Generate and sign client jar/pack200 files:
   
   
   Code:

   cd asm
   java -cp ... net.scapeemulator.asm.ClientBundler

   
   
6. Copy example serializer configuration into place:
   
   
   Code:

   cd game/data
   cp serializer.conf.example serializer.conf

   
   
7. Launch game server:
   
   
   Code:

   cd game
   java -cp ... net.scapeemulator.game.GameServer

   
   
8. Point your Internet browser to [Only registered and activated users can see links. ] and login with a username and password of your choosing. If the OpenGL client does not work, you can also use index.html or index_unsigned.html.
   
   
   

The example serializer configuration as used above makes the server use a 'dummy' serializer. Any username/password works, and players are not saved. To provide proper persistence, the MySQL serializer must be used.

Setting up MySQL is beyond the scope of this README, but once it has been done, to set up persistence you should:

1. Import the database schema:
   
   
   Code:

   cd unpackaged
   mysql -hHOST -uUSERNAME -pPASSWORD DATABASE < schema.sql

   
   
2. Update serializer.conf:
   
   
   Code:

   cd game/data
   cat >serializer.conf <<EOF
   type=jdbc
   url=jdbc:mysql://HOST/DATABASE
   username=USERNAME
   password=PASSWORD
   EOF

   
   
3. Manually create a user in the MySQL database. You'll also need to hash the password manually with bcrypt. There's no automated tool for doing this, sorry, and registration in the game is not functional.
   
   
   
4. Launch game server and web browser, as above. Login with the username and password you created in the previous step.
   
   
   

Originally Posted by Graham

An explanation of some of the cool stuff it's got:

Support for obscure parts of the protocol

As well as world list, ondemand, jaggrab and in-game support, it also has support for the auto login protocol (this is used in the signed clients where it has 'World: Auto', and the server sends back a world number for the client to connect to) and the registration protocol (although unfinished - the codecs are complete, but not the logic for dealing with them.)

Tools for creating a client using the original loader/client jars

The tool uses ASM to replace the parts of the bytecode (e.g. the hostname checking, the CRC checksums, the RSA key, the cache path) so that the original client/loader can be used to connect to the server. There's an in-built HTTP server to demonstrate this, just visit [Only registered and activated users can see links. ] when the game server is running.

Also I managed to find the native libraries corresponding to the version of JOGL jagex used at the time, so the client should work across Windows, Mac and Linux - 32 and 64 bit. Unfortunately I have no Mac to test it on though - but it has been tested on Windows and Linux. The unsigned client ofc works across all of them as it does not load the native libraries.

Benchmark

Tom asked for some benchmarks. There is a flooder module for you to test it on your own PC, but connecting 2k players on my PC (i5-2500k, 24g of RAM), the mean cycle time is ~92ms, with a standard deviation of ~14ms.

Some things ScapeEmulator lacks!

As it states in the README, you shouldn't just flock to this instead of using Apollo. Apollo is still your best choice for old engine servers, but it was never designed with the new engine in mind. So if you are making a new engine server, this may well be your best choice, but otherwise, I'd still recommend use of Apollo and carrying on with the development going on there (buroa, chris fletcher, etc. have released some really good stuff for Apollo.)

Some things Apollo has that this doesn't are: plugin system, multi-threaded updating, multi-protocol support, walkback support in the walking queue (although this would probably be reasonably easy to rip out of Apollo and add.) There are probably more.