-
Notifications
You must be signed in to change notification settings - Fork 2
How to contribute
All of this work always was and will be free, community-driven project. Contributing is what we need to do to keep it up.
Check out the Feedback page.
It's all Lua (scripting language TTS allows). It's quite intuitive and free-form like most scripting languages but it's easy to pile up bugs and issues. For security reasons (quite understandably), TTS environment you write scripts in is sanboxed heavily. No custom libraries import, no internet access, no filesystem access etc.
You can and should be highly encouraged to use Atom (free text editor) TTS plugin to write code in it instead of the in-game editor. Instructions on that, as well as complete scripting API and some quick overview can be found at the official Berserk Games knowledgebase.
Anything related to X-Wing on TTS you code up and deem as useful and working can be included. Documented code in a repository would be amazing. Contact me so we can work it up for next release.
If you'd rather improve what we already have, feel free to fork the repo, do stuff and submit a pull request.
Contributing to the Atom TTS plugin will be very appreciated by TTS community as well.
If you plan on using git version control with TTS scripts, keep in mind that files containing scripts (default at C:/Users/[username]/AppData/Local/Temp/TabletopSimulator/Lua) are temporary and change with each game load. I'd reccomend having your repo elsewhere and just copy the whole deal from there before commits.
Also, read up knowledgebase linked few paragraphs above and test yourself what Save&Play button does, how it is different from regular Save and Load. That can be frustrating as hell at first.
Which is cards, models, textures, in-game rulebooks, tokens, even playmat images. If you can do that, you're the man. ANY contribution in that area is golden, especially 3D models are a luxury we can't always get our hands on.
If you have something, just contact us in any way and I'll make sure to get back to you ASAP.
If you want to work on a ship model, below you can find resources and tips that should make your life easier and your content quality higher.
- Small base & peg model: https://drive.google.com/open?id=0B5NQRbuc_G9gckl2bzRjY2RyY3c
- Large base & peg model: https://drive.google.com/open?id=0B5NQRbuc_G9gZUlCY1VaZTZBOHc
- Faction colors template: https://drive.google.com/open?id=0B5NQRbuc_G9gMWpDTDRuc1VEdU0
- Strange Eons for generating base "cardboard" textures: Strange Eons
Notes on above:
- Do not scale base + peg model. Its current scale keeps it in line with other content. Scale ship model instead.
- You can "scale" the peg height by extruding its top face out.
- Everything aside from ship and "cardboard" part of base (inset rectangle on top side) should be textured with appropriate faction color.
- Strange Eons has X-Wing plugin that makes it incredibly easy to use. You should figure it out (ask if can't).
- Please make sure arc lines point at the corner of the inset part of the base.
- How to import a custom model in TTS.
- You can have your ship divided into submeshes when exporting, it should work fine
- TRIANGULATE FACES before export or it won't work.
- TTS renders only one side of each face so make sure normals are pointing out.
- For testing, leave collider field in TTS empty. We have standard colliders for large/small base ships anyway.
While donations are possible, keep in mind that they only help (go to) me. Contributing in any of the above ways instead both helps me and other contributors (what you did we don't have to spend time on doing) AND it directly helps the whole community that uses the mod.
Let me know what can be improved - Feedback. Have fun!