weyne/hoggit
1
0
Fork 0
mirror of https://gitlab.com/hoggit/developers/hoggit.git synced 2025-11-10 15:43:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added main file to squishy. Added LICENSE and README

Browse Source
This commit is contained in:
Jeremy Smitherman 2018-12-26 19:46:37 -06:00
parent 967bf6570e
commit 20888c611e
3 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# H.O.G.G.I.T. Framework
## Installation
##### This is for people who want to use the framework in their own missions
1. Get a copy of hoggit_framework-release-*-*-*.lua from http://framework.hoggitworld.com
2. in your mission add a trigger with action "DO SCRIPT FILE, click "OPEN" in the resulting dialog, and point it to the file you just downloaded.
3. the HOGGIT global is now available to scripts loaded after this. Check http://framework.hoggitworld.com and click "Documentation" for available functions.
## Development
##### This is for people who want to make changes or additions to the framework.
1. Check out the framework from git into a folder called HOGGIT at the location you wish to keep your DCS scripts (usually Saved Games\DCS\Scripts).
2. Copy hoggit_config.lua.example to <YOUR GAME INSTALL>/Scripts/hoggit_config.lua (NOT your Saved Games!) and change the values there to match your saved folder configuration. Do not include "HOGGIT" in the option for script_base, we just want a way that doesn't require desanitizing the lfs module to tell DCS where our Saved Games\DCS\Scripts folder is. If you look at hoggit.lua you can see the framework expects to be in a folder called HOGGIT under where you define your script_base.
3. Add a trigger for DO SCRIPT in your miz with the following code:
```
dofile([[Scripts\hoggit_config.lua]])
dofile(HOGGIT.script_base .. [[\HOGGIT\hoggit.lua]])
```
4. The Hoggit Framework is now in your lua environment and available to any scripts loaded after this point! Any changes you make to the checked out source will now be reflected when you reload your mission.

1
squishy
View File

@ -1,5 +1,6 @@
Output "dist/hoggit_framework.lua"
Main "hoggit.lua"
Main "hoggit/error_handling.lua"
Main "hoggit/logging.lua"
Main "hoggit/utils.lua"