mods/skybox/readme.md

   1
   2 ## skybox - a player skybox mod (and API!)
   3
   4 ### License of code and artwork
   5
   6 Copyright (C) 2017 - Auke Kok <sofar@foo-projects.org>
   7
   8 Provides a basic API for modifying a player sky box in a coherent
   9 fashion.
  10
  11 SkyboxSet by Heiko Irrgang ( http://gamvas.com ) is licensed under
  12 the Creative Commons Attribution-ShareAlike 3.0 Unported License.
  13 Based on a work at http://93i.de.
  14
  15 ### Usage
  16
  17 The `skybox` privilege allows players to change their own sky boxes.
  18 The command allows listing, and changing skyboxes, or turning skybox
  19 settings `off`.
  20
  21 ### API
  22
  23 The `skybox` handle can be used to perform various actions:
  24
  25 `skybox.clear(player)`
  26  -- Reverts the player skybox setting to the default.
  27
  28 `skybox.set(player, number)`
  29  -- Sets the skybox to the `number` in the list of current skyboxes.
  30
  31 `skybox.add(skyboxdef)`
  32  -- Add a new skybox with skyboxdef to the list of available skyboxes.
  33
  34
  35 ```
  36 skyboxdef = {
  37         [1] -- Base name of texture. The 6 textures you need to
  38             -- provide need to start with this value, and then
  39             -- have "Up", "Down", "Front", "Back", "Left" and
  40             -- "Right", Followed by ".jpg" as the file name.
  41         [2] -- Sky color (colorstring)
  42         [3] -- Day/Night ratio value (float - [0.0, 1.0])