@geckos.io/client

Real-time client/server communication over UDP using WebRTC and Node.js

Usage no npm install needed!

<script type="module">
  import geckosIoClient from 'https://cdn.skypack.dev/@geckos.io/client';
</script>

README

logo

@geckos.io/client

NPM version Downloads Node version Minified bundle Snyk Vulnerabilities for GitHub Repo (Specific Manifest) NPM Codecov ES Modules Badge

Real-time client/server communication over UDP using WebRTC and Node.js.

This framework fits perfectly with your next HTML5 real-time multiplayer games or chat app.

Read the documentation for more information.

Install

npm install @geckos.io/client

Use

import geckos from '@geckos.io/client'

// or add a minified version to your index.html file
// https://github.com/geckosio/geckos.io/tree/master/bundles/versions

const channel = geckos()

channel.onConnect(error => {
  if (error) {
    console.error(error.message)
    return
  }

  channel.on('chat message', data => {
    console.log(`You got the message ${data}`)
  })

  channel.emit('chat message', 'a short message sent to the server')
})