TenIO is an open-source project to create multiplayer online games that includes a java NIO (Non-blocking I/O)
based server specifically designed for multiplayer games, which supports UDP, TCP, Websocket, HTTP transports, and available simple client projects for quick development.
This project contains a collection of examples that show you how to manipulate the framework.
- tenio-core 0.6.0
- tenio-engine 0.5.0- Java 17
The TenIO project is currently available under the MIT License.
Please check out the changelog for more details.
Please check out the contributing guideline for more details.
$ git clone https://github.com/congcoi123/tenio-examples.git- Establishes a simple server with only a single Java class
/**
* This class shows how a simple server handle messages that came from a client.
*/
@Bootstrap
public final class TestSimpleServer {
public static void main(String[] params) {
ApplicationLauncher.run(TestSimpleServer.class, params);
}
/**
* Create your own configurations.
*/
@Setting
public static class TestConfiguration extends CoreConfiguration implements Configuration {
@Override
protected void extend(Map<String, String> extProperties) {
for (Map.Entry<String, String> entry : extProperties.entrySet()) {
var paramName = entry.getKey();
push(ExampleConfigurationType.getByValue(paramName), String.valueOf(entry.getValue()));
}
}
}
/**
* Define your handlers.
*/
@EventHandler
public static class ConnectionEstablishedHandler extends AbstractHandler
implements EventConnectionEstablishedResult {
@Override
public void handle(Session session, DataCollection message,
ConnectionEstablishedResult result) {
if (result == ConnectionEstablishedResult.SUCCESS) {
var request = (ZeroMap) message;
api().login(request.getString(SharedEventKey.KEY_PLAYER_LOGIN), session);
}
}
}
@EventHandler
public static class PlayerLoggedInHandler extends AbstractHandler
implements EventPlayerLoggedinResult<Player> {
@Override
public void handle(Player player, PlayerLoggedInResult result) {
if (result == PlayerLoggedInResult.SUCCESS) {
var parcel = map().putString(SharedEventKey.KEY_PLAYER_LOGIN,
String.format("Welcome to server: %s", player.getName()));
response().setContent(parcel.toBinary()).setRecipientPlayer(player).write();
}
}
}
@EventHandler
public static class ReceivedMessageFromPlayerHandler extends AbstractHandler
implements EventReceivedMessageFromPlayer<Player> {
@Override
public void handle(Player player, DataCollection message) {
var parcel =
map().putString(SharedEventKey.KEY_CLIENT_SERVER_ECHO, String.format("Echo(%s): %s",
player.getName(),
((ZeroMap) message).getString(SharedEventKey.KEY_CLIENT_SERVER_ECHO)));
response().setContent(parcel.toBinary()).setRecipientPlayer(player).write();
}
}
}- Supports self-defined commands to interact with the server conveniently
- Usage
2022-11-20 05:20:38,256 [main] INFO com.tenio.core.server.ServerImpl - [SERVER][Example] Started
$ help
help - Shows all supporting commands
[<command>,<command>,<command>]
info - Provides brief information about players and rooms on the server
player
room
player - Logout the first player from the server
logout first
server - Allows stopping or restarting the server
stop
restart
unban - Allows removing banned Ip addresses from the ban list
[<address>,<command>,<command>]
$ info player
> There are 1 players > The first 10 entities > [Player{name='IkjvI', properties={}, session=Session{id=0, name='IkjvI', transportType=TCP, createdTime=1668918078524, lastReadTime=1668918078524, lastWriteTime=1668918078524, lastActivityTime=1668918078524, readBytes=75, writtenBytes=120, droppedPackets=0, inactivatedTime=0, datagramRemoteSocketAddress=null, clientAddress='127.0.0.1', clientPort=60659, serverPort=8032, serverAddress='127.0.0.1', maxIdleTimeInSecond=0, activated=true, connected=true, hasUdp=false, enabledKcp=false, hasKcp=false}, currentRoom=null, state=null, roleInRoom=SPECTATOR, lastLoginTime=1668918078589, lastJoinedRoomTime=1668918078588, playerSlotInCurrentRoom=-1, loggedIn=true, activated=true, hasSession=true}]
$
- Make sure to set the command usage flag in setting.json file to be enabled
{
"command": {
"enabled": true
},
"plugin": {
"enabled": false,
"path": "/plugin"
}
}- Simple implementation
@Command(label = "player", usage = {
"logout first"
}, description = "Logout the first player from the server")
public class PlayerCommand extends AbstractCommandHandler {
@Override
public void execute(List<String> args) {
var action = args.get(0);
var param = args.get(1);
if (action.equals("logout") && param.equals("first")) {
var players = api().getReadonlyPlayersList();
if (players.isEmpty()) {
CommandUtility.INSTANCE.showConsoleMessage("Empty list of players.");
return;
}
var firstPlayer = players.get(0);
CommandUtility.INSTANCE.showConsoleMessage("Player {" + firstPlayer.getName() + "} is " +
"going to logout.");
api().logout(firstPlayer);
} else {
CommandUtility.INSTANCE.showConsoleMessage("Invalid action.");
}
}
}Please start the server before its corresponding client in each example package.
$ java <server_main_class> <server_configuration_file.xml>
For instance:
$ java TestServerLogin configuration.example1.xml
|-- example
|-- example0
| |-- TestSimpleClient
| |-- TestSimpleServer
|-- example1
| |-- TestClientLogin
| |-- TestServerLogin
|-- example2
| |-- (*)TestFsmMechanism
|-- example3
| |-- TestClientAccessDatagramChannel
| |-- TestServerAccessDatagramChannel
|-- example4
| |-- TestClientMovement
| |-- TestServerMovement
| |-- (*)TestMovementMechanism
|-- example5
| |-- (*)TestEcsMechanism
|-- example6
| |-- TestClientEchoStress
| |-- TestServerEchoStress
|-- example7
| |-- TestServerWebsocket
|-- example8
| |-- TestClientRestful
| |-- TestServerRestful
|-- example9
| |-- TestClientKcpEcho
| |-- TestServerKcpEcho
|-- example10
| |-- TestClientMsgPackEcho
| |-- TestServerMsgPackEcho
|-- example11
| |-- TestClientCommand
| |-- TestServerCommandHappy coding !
