Terminus-game-dev-1 NPM

Terminus Industries Game API

WARNING: Currently incomplete. Key functionality is still being worked on. Use at your own risk.

A Brief Introduction...

When I set out to make this, I aimed to introduce adaptability into a framework I had created. I am by no means a professional, but I do enjoy being able to streamline the process for others!

I am currently working on resecuring the client stuff so that we can avoid exploits. I'm not sure how to pass checks on movements or actions yet, so it won't be perfect.

~ J (Nightstrike)

Dependencies

These are not necessary to state explicitly, but if for some reason they don't get pulled when you use this package, then please refer to this repo's index.js for how you'd reference your imports.

Socket.io - Handles websocket connections. ESSENTIAL to your application, or else it won't run.
```
var socketIO = require('socket.io');
```
Express - allows the webpage to be served.
```
var express = require('express');
```
http, path, etc. ...

Setup

Example Setup:

//Dependencies
var express = require('express');
var http = require ('http');
var path = require ('path');
var socketIO = require ('socket.io');
var fs = require ('fs');

//Base setup
var app = express();
var server = http.Server(app);
var io = socketIO(server);

var terminus = require("terminus-game-dev-1");

//Establish server for hosting. You'll want to also put in your scripts before going live with your game.

terminus.initSetup(8000, "./lobby.html","./script.js");

Usage

This API was designed to introduce functions that make it easier to manage your games, and focus less on the implementation of other modules.

Server-side

initSetup() - This command performs your initial setup, and generates your main files. It's used for initializing your workspace, not correcting corrupted files. Keep in mind the folder layout as you set up your references. This will also launch your game, but connections can be quickly closed if need be.
- <'html'> - the name of your served file. Remember to namespace sections properly!
- <'script'> - Your reference file for handling things client-side.
- <'port'> - Straightforward. It's recommended you use one of the defaults for your main server, such as 5000, or 8080.

Example:

initServer(8000, './lobby.html', './script.js');
//then...
initPlayer();

//Result: Serves a lobby with a static folder and the potential for additional client-side asset deployment. Nearly ready! Minor bugs are present at this point Additionally, once you've got your client-side stuff set up, it will register your connection.

initPlayer() - This will facilitate the Websocket connection for players. Currently, playerdata is being incorporated into this, so as to resecure client instances.

Client-side

clientConnect() - This will transmit your data upon connection. It's currently a work-in-progress, so security is non-existent, and anyone can exploit it.
- <'start'> - Defined JSON variable, which will be unified for every user. It includes all the data a user starts with.
- <'button'> - The name of your chat-send button. Necessary, but you can hide it if you set chatState to false.
- <'txtInput'> - The name of your text input. Again, necessary, but you can hide it if you don't want to implement a chat feature.
- <'chatState'> - Boolean. Defines transmission of messages to server, and other users.
```
var exampleStart = {
  "username":"Guest",
  "Password":"", //Will eventually implement MD5 for added security, but it's a GAME. 
  "HP":"100", //Usage of this is recommended for victory/defeat mechanics.
  "X":"400",
  "Y":"400"
}
clientConnect(exampleStart,"sendmessage","msgContent",true);

//Result: Transmits data for each user who connects to the server. That data can then be managed by the operator.
```

To-do

initServer(port,html,script)
- Server starts up!
- Communication with /static folder.
- Generation of Database folder.
  - Archive logging.
initPlayer()
- Data transmitted, including messages
  - BUGFIX: Message sending breaks loop, resulting in repeated logs of player info.
- Movement handlers
  - Top-view
  - Side-scrolling
  - 3D (three.js)
- Physics
  - Gravity
  - Acceleration
  - Sliding
- Gameplay types
  - Racing
  - PVP
    - FPS
- Gamemode handlers
- Rendering Handlers
- Functionality: Store data server-side to prevent exploits.
Accounts
- Transmission of data (i.e. presets and messages)
- DB for account access and recording of data.
- Failsafes.