https://github.com/Lautenschlager-id/Fromage
An API for the Atelier801's forums.
https://github.com/Lautenschlager-id/Fromage
api atelier801 bot forum fromage lua luvit transformice transfromage
Last synced: over 1 year ago
JSON representation
An API for the Atelier801's forums.
- Host: GitHub
- URL: https://github.com/Lautenschlager-id/Fromage
- Owner: Lautenschlager-id
- License: mit
- Created: 2018-12-01T18:37:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-13T21:00:07.000Z (about 6 years ago)
- Last Synced: 2024-07-29T19:13:27.291Z (almost 2 years ago)
- Topics: api, atelier801, bot, forum, fromage, lua, luvit, transformice, transfromage
- Language: Lua
- Size: 4.32 MB
- Stars: 9
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOGS.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TSTEG3PXK4HJ4&source=url)
**Atelier801's Forum API written in Lua (5.1▲) using the Luvit runtime environment**
## About
The [Atelier801's Forum](https://atelier801.com/forums) is a forum created by the french company [Atelier801](http://societe.atelier801.com/) for players from [Transformice](https://www.transformice.com/), an online independent multiplayer free-to-play platform video game, and other smaller projects.
[Luvit](https://luvit.io/) is an open-source, asynchronous I/O Lua runtime environment that makes HTTP requests possible for the Lua programming language.
**Fromage API** is a [documented RESTful API](docs) that allows developers to make bots for the mentioned forum.
Join the **_[Fifty Shades of Lua](https://discord.gg/quch83R)_** [discord](https://discordapp.com/) to discuss about this API and to have special support.
See also the **[TransFromage API](https://github.com/Lautenschlager-id/Transfromage)** for the game Transformice.
## Installation
- To install Luvit, visit https://luvit.io and follow the instructions provided for your platform.
- If you have problems installing it on Windows, please use [Get-Lit](https://github.com/SinisterRectus/get-lit)
- To install **Fromage**, run `lit install Lautenschlager-id/fromage`
- Run your bot script using, for example, `luvit bot.lua`
###### If you are new and can't follow these steps, please consider using the _MyFirstBot.zip_ that comes with the executables and API already.
_(4MB)_ [Windows](https://github.com/Lautenschlager-id/Fromage/raw/master/MyFirstBot/Windows.zip) | [Linux](https://github.com/Lautenschlager-id/Fromage/raw/master/MyFirstBot/Linux.zip)
### API Update
To update the API automatically all you need to do is to create a file named `autoupdate` in the bot's path.
You can create it running `echo >> autoupdate` (for Windows) or `touch autoupdate` (for Linux);
The update will overwrite all the old files and dependencies.
For semi-automatic updates (asks permission before updating), create the file `semiautoupdate` instead.
## Base example
```Lua
local api = require("fromage")
local client = api()
coroutine.wrap(function()
client.connect("Username#0000", "password")
if client.isConnected() then
-- TODO
end
client.disconnect()
os.execute("pause >nul")
end)()
```
## Contributors
###### This project follows the [all-contributors](https://allcontributors.org/docs/en/emoji-key) specification.
