swampservers/contrib
CONTRIBUTOR LICENSE AGREEMENT: This repository is solely for game assets/code used by Swamp Servers to operate our online games. By submitting your work to this repository (via commits/pull requests), you agree that we have a PERMANENT, IRREVOCABLE, WORLDWIDE, TRANSFERABLE LICENSE to use, modify, and distribute all of your submitted work as we see fit. By submitting work created by a third party, you attest that the creator of that work also agrees that we have a permanent, irrevocable, worldwide, transferable license to use, modify, and distribute their submitted work as we see fit. Do not submit work from a third party without their agreement to these terms. Note that work publicly available on sites like "Steam Workshop" may already be distributed under agreements conducive to this.
COPYRIGHT: This repository and most of its content is copyrighted and owned by Swamp Servers. All other content is, to the best of our knowledge, used under license. If your copyrighted work is here without permission, please contact the email shown here. This repository DOES NOT license its contents to be used for other purposes, nor does its existence on GitHub imply such a license.
Overview
Contribute to Swamp Cinema here! How to:
- 'Fork' this repo. This creates a copy of it you have edit permissions of.
- Clone your forked repo, edit it, and push it back. You'll need the Github desktop or commandline client. Look up GitHub tutorials for that.
- Make a pull request on this repo. Use the 'compare across forks' link to request to merge your changes on your forked repo to this repo. We'll review the changes and, if accepted, will be live the next day.
Don't worry about workshop addons or any of that. All files in here will be automatically uploaded to workshop. (Except lua which isn't run off of workshop)
how tos
Shop Weapons:
Add the weapon to lua/weapons/ as normal (See API for coding stuff)
Register the weapon in lua/sps/items/free.lua or lua/sps/items/weapons.lua as shown
Add the weapon to lua/sps/categories.lua
One time use models:
Upload the playermodel
Register in lua/sps/items/uniquemodels.lua
Add to lua/sps/categories.lua
Props ("wearables"):
Upload model, add to wearables.lua, add to categories.lua
Add the uploaded files to commonfiles.txt because wearables are usable across servers
api
see lua/autorun/player_extension.lua:
player:IsPony()
player:IsAFK()
player:GetRank() (0 for players 1+ for staff)
entity:ExtEmitSound(soundname, options): its basically like EmitSound but does stuff so that if one guy is in a theater he won't hear it if its played outside the theater. It also handles the "lip syncing" (not really syncing - they move randomly) for speech sounds. options is a keyvalue table (or nil), possible arguments are:
- pitch
- crouchpitch
- level
- volume
- channel
- ent: emit from this ent instead of player
- shared: emit on client without networking, assuming called in shared function
- speech: move player lips (time to move lips, or auto if < 0)
player:GetLocation(): returns a integer for what location they are at player:GetLocationName(): gets the location name (look at the cinema gamemode for more on this, the swamp version is similar)
global function: Safe(player or entity): is the player/entity in a safe/protected area or otherwise safe