your-land/yl_survey_fs
20
0
Fork 0
generated from your-land/yl_template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
8 Commits 1 Branch 0 Tags 1.1 MiB
Lua 100%
master
Go to file
AliasAlreadyTaken 1e098338a5 luacheck and formatting
2024-10-08 13:39:06 +02:00
dev Initial commit 2024-09-21 08:49:15 +00:00
.luacheckrc Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
api.lua Implements formpsec cache and storing 2024-10-03 12:14:24 +02:00
config.lua luacheck and formatting 2024-10-08 13:39:06 +02:00
information.lua Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
init.lua Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
initialize.lua Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
internal.lua luacheck and formatting 2024-10-08 13:39:06 +02:00
LICENSE-CC0 Initial commit 2024-09-21 08:49:15 +00:00
LICENSE-MIT Initial commit 2024-09-21 08:49:15 +00:00
LICENSE.md Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
mod.conf Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
README.md Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
screenshot.png Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
settingtypes.txt Replaces all mentions of template with yl_survey_fs and throws out unnecessary files 2024-09-21 11:10:42 +02:00
texts.lua Implements Cache and start button 2024-09-25 18:04:50 +02:00

README.md

yl_survey_fs

Purpose

This mod contains functions to deliver survey formspecs to participants and store their opinion.

Download

Get it from https://gitea.your-land.de/your-land/yl_survey_fs

Dependencies

See mod.conf

Installation

  1. Copy the "yl_survey_fs" folder to your mod directory.
  2. Make sure the dependencies are satisfied, if any.
  3. Enable the mod in your world.mt file.

Configuration

yl_survey_fs.debug = false

Set to true to enable debug mode

Usage

This mod targets servers, but should work in singleplayer, too. It comes with no direct content but exposes functions you can use in your mod.

Chatcommands

Modmakers

Use the following public functions to deliver the survey formspecs

yl_survey_fs.deliver_survey(playername, survey_id)

Returns true if the survey could be sent to the player, false, "errormessage" if not.

Limitations

  • Only "respond to a survey" included
  • Creation of surveys in the next iteration

Alternatives

Supported versions

If you use yl_survey_fs, but something is wrong, please file a bug. PRs also welcome.

There is no reason to believe it doesn't work anywhere, but you never know.

Allied projects

If you know a project that uses this mod tell us and we will add it to the list.

Uninstall

Remove it from your mod folder or deactivate it in your world.mt

Mods that depend on it will cease to work, if the mod is removed without proper replacement.

License

See LICENSE.md

  • Code MIT AliasAlreadyTaken
  • Screenshot CC0 Styxcolor

Thank you