Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.88 KB

README.md

File metadata and controls

95 lines (67 loc) · 3.88 KB
Raw

PollNet v0.4

Http multiplayer game library for GameMaker Studio 2. Pollnet is designed to create lobbies/chats, or turn based games and it's not suitable for realtime games.

Table of contents

Installation

Do the following steps in order.

1) PHP Configuration

Open config.php and edit the following fields

$dbusername = "tizsoft"; // your username
$password = ""; // your mysql password
$host = "localhost";
$database = "my_tizsoft"; // database name

$update_interval = 2; //update interval in seconds

2) PHP Installation

  • Upload all the php files on a directory of your website (e.g. http://your_website.com/your_directory/)
  • Open the url to install.php (e.g. http://your_website.com/your_directory/install.php)
  • done

3a) Import the extension in GMStudio2

  • Create a new project
  • Drag and drop the extension file (pollnet_extension.yymp) into GMStudio2

3b) Or open an example project

./examples/chat/ directory ./examples/hangman/ directory

4) GMStudio2 Configuration

  • Open the pn_config script inside GMStudio2
  • and change the following line, to your website pollnet directory url global.pn_website = "http://my-awesome-website.com/pollnet/";

Usage

Instantiate obj_pollnet before calling any function

Functions

  • pn_host : create a new lobby
  • pn_game_start : called by the host to start the game (use it when you reached the desired number of players in the lobby), since this moment, new players can't join the game
  • pn_join : join an existing lobby
  • pn_request_games_list : get all the online lobbies (created by other players)
  • pn_quit : leave a lobby
  • pn_send : send a message to one or all players (set the second parameter to all) example: `pn_send("health", all, 80)

Events

All the scripts under events group are called when something happens

For example:

  • pn_on_player_join is called when a player (included yourself) joins the lobby.
  • pn_on_player_quit is called when a player (included yourself) leaves the lobby.

Global Variables

  • global.pn_last_date: last message date
  • global.pn_players_map: ds_map between players id and name
  • global.pn_players_list: ds_list of players id
  • global.pn_games_list: ds_list of games
  • global.pn_admin_id: player id of the host
  • global.pn_player_id: your id in the lobby

Tips

  • Create an object that lists all the available games online and allows to join
  • Create a button to host a new game
  • use pn_send to send messages with an id of your choice
  • with pn_send you can send a string a number or an array
  • inside the script pn_on_receive use a switch statement to handle the messages
  • don't send too much data, this library uses HTTP connection / mysql database, to avoid performance issues.

License

MIT LICENSE

Copyright 2022 Adriano Tumminelli

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.