GMnet ENGINE Manual: Index

Welcome! Below you will find all pages of this manual. If you are new, start with the tutorial.

Some sections may have a PLUS prefix. These pages are only relevant if you are using GMnet ENGINE. If you are GMnet CORE or if you disabled GMnet PUNCH in the settings, these pages do not apply for you. For more information, check the page on differences between GMnet CORE and ENGINE

Note: GMnet ENGINE was previously called the "HappyTear Multiplayer Engine" (or HTME for short). This name may be still present on some pages of the manual, also all scripts and files are prefixed with "HTME" for this reason. GMnet PUNCH was previously called UDPHP, the same applies for it.

Tutorial / Getting Started

This tutorial will guide you through the creation of the platformer that comes with the engine and teaches you how to use the engine.

1. What is GMnet ENGINE?
2. Basic configuration
3. PLUS - Setup GMnet PUNCH
4. PLUS - Hosting a mediation server
5. Starting the engine
6. Setting up the basic platformer
7. The network controller
8. Adding a player
9. A second room and doors
10. Making an overlay that shows the name of connected players
11. Adding day/night
12. Creating a chat system
13. Conclusion / What's next
14. PLUS - Bonus 1 - ONLINE lobby
15. Bonus 2 - Global Sync (Sync a pool of variables editable by all)
16. Bonus 3 - LAN lobby
17. Bonus 4 - Event Handlers for Connecting/Disconnecting
18. Bonus 5 - RPC

Important Concepts

• Local and remote Instances
• Instance scope and rooms
• Players and Playerhashes
• States of the engine
• Variable Groups
• mp_map_syncIn and mp_map_syncOut
• VarGroup SyncTypes (mp_type)
• Tolerance
• Buffer types
• CHAT Interface
• PLUS - GMnet PUNCH
• PLUS - Master server (GMnet GATE.PUNCH)
• Signed packets
• The debug overlay
• PLUS - GMnet GATE.TESTER

Basic Function Reference

Sync Functions (mp_*)

• mp_sync
• mp_unsync
• mp_stayAlive
• mp_add
• mp_addPosition
• mp_addBuiltinBasic
• mp_addBuiltinPhysics
• mp_setType
• mp_tolerance
• mp_map_syncIn
• mp_map_syncOut

Tools

• htme_isLocal
• htme_clientIsConnected
• htme_clientConnectionFailed
• htme_isStarted
• htme_isServer
• htme_getPlayers
• htme_findPlayerInstance
• htme_getPlayerNumber
• htme_clientDisconnect
• htme_serverDisconnect
• htme_serverShutdown

CHAT Interface

• mp_syncAsChatHandler
• mp_chatGetQueue
• mp_chatSend
• htme_chatGetMessage
• htme_chatGetSender

Online Lobby

• udphp_downloadServerList

LAN Lobby

• htme_startLANsearch
• htme_stopLANsearch

Global Sync

• htme_globalGet
• htme_globalSet
• htme_globalSetFAST

Event handlers

• htme_serverEventHandlerConnecting
• htme_serverEventHandlerDisconnecting

Configuration

• htme_init

More documentation may be added later. You can find a documentation of every script in the header of the script files.

FAQ and More

• Extending the Engine / Advanced Use
• How to update

More will be added to this section later.

Support

Please use the forums for support. We will answer there.

Back to index.

All pages in this manual are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.