https://github.com/diazvictor/sdl-net
A simple library for sending and receiving data (with Lua-SDL2)
https://github.com/diazvictor/sdl-net
lua sdl2 sdl2-net
Last synced: 5 months ago
JSON representation
A simple library for sending and receiving data (with Lua-SDL2)
- Host: GitHub
- URL: https://github.com/diazvictor/sdl-net
- Owner: diazvictor
- License: mit
- Created: 2021-02-20T17:11:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-21T02:36:01.000Z (almost 5 years ago)
- Last Synced: 2025-04-03T11:51:15.002Z (9 months ago)
- Topics: lua, sdl2, sdl2-net
- Language: Lua
- Homepage:
- Size: 93.8 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## sdl-net
A simple library for sending and receiving data via networking with Lua-SDL2
To run this example:
```
cd example/
lua server.lua
```
In a separate terminal run `client.lua`
## Dependencies
- Lua 5.1 (or LuaJIT 2.0)
- [Lua-SDL2](https://github.com/tangent128/luasdl2/)
## Documentation
* `sdl_net:new([username, host, port])`: This will create a new client. Arguments:
* (**string**) `username`: The user name. Default is "johndoe".
* (**string**) `host`: The Server to be connected to. Default is "localhost".
* (**number**) `port`: The Server port. Default is 5959.
_(note: you can also do require('sdl_net')(**ARGUMENTS**)_
* `sdl_net:connect()`: Establish the connection to the server.
* `sdl_net:composer(message)`: Compose a message into JSON data. Arguments:
* (**string**) `message`: The message to be sent.
* `sdl_net:send()`: Send the aftermentioned composite message.
* `sdl_net:disconnect()`: Disconnect from the server.
## Usage
```lua
local sdl_net = require 'sdl_net'
local client = sdl_net:new()
client:connect()
client:composer('Hello World')
client:send()
client:disconnect()
```
### Usage 2:
```lua
local client = require('sdl_net')()
client:connect()
client:composer('Hello World')
client:send()
client:disconnect()
```
## TODO:
* Implement the method to receive the messages (currently they are previewed in a separate script).
## Contributing:
Pull requests are welcome. For major changes, please open an issue first and discuss what you would like to change.
Please make sure to update the tests as appropriate.
## License:
[MIT](LICENSE.md)