diff options
author | amione <57235791+xamionex@users.noreply.github.com> | 2022-02-04 16:16:50 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-04 16:16:50 +0100 |
commit | 1ecd37b2ef1f68abccb686a2f7cb0bdd1802cb14 (patch) | |
tree | a0014d0c255643e9c841606d97596918141802ab | |
parent | cddf675463573c38b5e93926825ab438fc796eaf (diff) | |
download | NorthstarWiki-1ecd37b2ef1f68abccb686a2f7cb0bdd1802cb14.tar.gz NorthstarWiki-1ecd37b2ef1f68abccb686a2f7cb0bdd1802cb14.zip |
Updating Wiki Stuff (#39)
* add more issues so people don't ask over and over
* fix improper indentation
* MD026/no-trailing-punctuation
* remove issues from faq and link to troubleshooting
* MD001/heading-increment
* fulfill*
* MD032/blanks-around-lists
* MD001/heading-increment
* MD033/no-inline-html
* revert MD Rule (not sure what this <a> is used for
* me when i didnt mean to do that
* use da link and also when the... what
* bin folder
* Formatting
Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
* Formatting
Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
* fix intel link
* MD034/no-bare-urls: Bare URL used
* MD045/no-alt-text
* MD012/no-multiple-blanks
* I know this is unused, just wanted to write smth
* fix links
* add tools
* please stop using real urls. you have markdown.
* modding tools
* add tools
* no actual urls <3
* fix tools link
* does this look better?
* nope
* remove "some stuff"
* better formatting
* oops
* oops v2
* GitBook: [#1] No subject
* i didnt create this
* MD Rules
* Update docs/modding/tools.md
Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
* Update docs/modding/README.md
Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
* move mtools down
* change vtfedit
* rem tools
* no winrar. bad.
* non-shortened url
* add kvals to summary
Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
-rw-r--r-- | CODE_OF_CONDUCT.md | 10 | ||||
-rw-r--r-- | docs/SUMMARY.md | 2 | ||||
-rw-r--r-- | docs/development.md | 1 | ||||
-rw-r--r-- | docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md | 7 | ||||
-rw-r--r-- | docs/hosting-a-server-with-northstar/prerequisites.md | 4 | ||||
-rw-r--r-- | docs/hosting-a-server-with-northstar/troubleshooting.md | 22 | ||||
-rw-r--r-- | docs/installing-northstar/basic-setup.md | 6 | ||||
-rw-r--r-- | docs/installing-northstar/using-northstar/commands.md | 7 | ||||
-rw-r--r-- | docs/installing-northstar/using-northstar/gamemodes.md | 2 | ||||
-rw-r--r-- | docs/installing-northstar/using-northstar/mods.md | 7 | ||||
-rw-r--r-- | docs/installing-northstar/using-northstar/playing-on-linux.md | 15 | ||||
-rw-r--r-- | docs/modding/README.md | 17 | ||||
-rw-r--r-- | docs/modding/getting-started.md | 14 | ||||
-rw-r--r-- | docs/modding/keyvalues.md | 12 | ||||
-rw-r--r-- | docs/modding/tools.md | 68 |
15 files changed, 134 insertions, 60 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index ebebb31..6a24ef9 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -59,8 +59,7 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -https://github.com/R2Northstar. +reported to the community leaders responsible for enforcement [here](https://github.com/R2Northstar). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -115,14 +114,11 @@ the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +version 2.0, available [here](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +For answers to common questions about this code of conduct, see the FAQ [here](https://www.contributor-covenant.org/faq). Translations are available [here](https://www.contributor-covenant.org/translations). diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ea29aff..38ace26 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -34,6 +34,7 @@ * [Modding](modding/README.md) * [Getting Started](modding/getting-started.md) + * [Modding Tools](modding/tools.md) * [Tutorials](modding/tutorials/modding-tutorials.md) * [Cheatsheet](modding/cheatsheet.md) * [Squirrel](modding/squirrel/what-is-squirrel.md) @@ -48,6 +49,7 @@ * [The JSON](modding/squirrel/setting-mods/the-json.md) * [The Language File](modding/squirrel/setting-mods/the-language-file.md) * [The mod file](modding/squirrel/setting-mods/the-mod-file.md) + * [Keyvalues](modding/keyvalues.md) * [Setup Syntax Highlighting](modding/squirrel/setup-syntax-highlighting.md) * [Localisation](modding/localisation\_files.md) * [Finishing touches](modding/finishing-touches.md) diff --git a/docs/development.md b/docs/development.md index 80db02a..11f2e9b 100644 --- a/docs/development.md +++ b/docs/development.md @@ -26,4 +26,3 @@ Northstar is split over multiple git repositories that fulfill different functio Build instructions for the launcher can be found here: {% embed url="https://github.com/R2Northstar/NorthstarLauncher/blob/main/BUILD.md" %} - diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md index 834ff77..6128d5c 100644 --- a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md +++ b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md @@ -4,7 +4,6 @@ description: Tweaks and tricks to improve both your experience in hosting and ot # Best practices - {% hint style="info" %} TODO: If you have experience in hosting Northstar servers and want to share your knowledge, please open a [pull request](https://github.com/R2Northstar/NorthstarWiki/pulls). {% endhint %} @@ -17,14 +16,12 @@ The current minimum requirements are as follows: - 5GB free disk space (+3 GB if you're on windows due to origin and deps) - 3+ cores (2 might work, though) -- 6GB+ total memory (RAM or swap will do) -- Windows 8.1 (and built-in WARP [use `-softwared3d11`] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see https://git.io/JyrOR for wine details) - +- 6GB+ total memory (RAM or swap will do) +- Windows 8.1 (and built-in WARP [use `-softwared3d11`] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see [this](https://github.com/pg9182/northstar-dedicated) for more) **Per instance:** - 2GB RAM (this is what's actually used; it does drop to ~1.2GB after a bit) - 15 Mbps network upload, but 10 is workable, 25 if you want to avoid players getting disconnected when going back to the lobby after a match - **Note:** It is recommended to surpass the listed requirements. Currently the number of available servers covers the daily playerbase more than enough. If you're planning to host public servers for the community it is therefore recommended to either fill a niche (like a gamemode that is so popular that all existing servers are full) or provide a better service than existing hosts (less lag, more stable, etc.). diff --git a/docs/hosting-a-server-with-northstar/prerequisites.md b/docs/hosting-a-server-with-northstar/prerequisites.md index ce2cdd2..4448352 100644 --- a/docs/hosting-a-server-with-northstar/prerequisites.md +++ b/docs/hosting-a-server-with-northstar/prerequisites.md @@ -9,7 +9,7 @@ Hosting your own server of any kind requires basic knowledge of computer network If you for example don't know what "port forwarding" means and just want to play private matches with your friends it is generally recommended to just find an empty public server instead of trying to host your own server. {% endhint %} -## Check whether you can port forward: +## Check whether you can port forward In order for others to join your game they need to be able to reach you. Most likely your router acts as a NAT so you need to port forward two ports to your PC for [NAT traversal](https://en.wikipedia.org/wiki/NAT\_traversal). @@ -21,7 +21,7 @@ For this find out your external IP address [by visiting this site](https://www.w Then [open CMD](https://www.lifewire.com/how-to-open-command-prompt-2618089#toc-open-command-prompt-in-windows-10) and type in: -``` +```txt tracert <your external IP address here> ``` diff --git a/docs/hosting-a-server-with-northstar/troubleshooting.md b/docs/hosting-a-server-with-northstar/troubleshooting.md index c4f7ea0..847e836 100644 --- a/docs/hosting-a-server-with-northstar/troubleshooting.md +++ b/docs/hosting-a-server-with-northstar/troubleshooting.md @@ -1,4 +1,5 @@ # Document is empty + `[error] Failed reading masterserver authentification response: encountered parse error 'The document is empty.'` Masterserver needs to request your gameserver for it to be authentified and registered. @@ -16,23 +17,23 @@ Your server **must** be running while you check if the server is reachable. ## If server is reachable using external IP -#### Your GameServer is out of date +### Your GameServer is out of date Check that your server is running on the latest Northstar release as it can sometimes include breaking changes. -#### Mastserver is down +### MasterServer is down Check Northstar's Discord for annoucements. -https://northstar.tf giving you a HTTP 523 error means that the masterserver is offline. +[https://northstar.tf](https://northstar.tf) giving you a HTTP 523 error means that the masterserver is offline. -#### Ports are not the same +### Ports are not the same Your gameserver is configured to listen to a given TCP port. Masterserver needs to be able to contact your gameserver though that same port. -#### Another Northstar Server is using the port +### Another Northstar Server is using the port Shutdown every other server to narrow down the problem @@ -42,7 +43,7 @@ This won't generally help but will allow you to avoid checking for the wrong ser Check if your server is reachable from your internal network's IP (often starts with `192.168.x.x`) -#### Firewall is blocking tcp ports +### Firewall is blocking tcp ports In some cases your Firewall or antivirus can prevent your ports to be exposed to your local network. To fix this issue, make a rule to allow your server to listen on your network. @@ -50,20 +51,19 @@ Disabling the firewall and antivirus can also work, even if it's not reccomended ## If server is not reachable using external IP but reachable using internal IP -#### Router configuration is incorrect +### Router configuration is incorrect If your port can be accessed from your local IP but not from your public IP, then it's very likely that your NAT rules aren't properly configured. -#### CGNAT +### CGNAT See [CGNAT](https://r2northstar.gitbook.io/r2northstar-wiki/hosting-a-server-with-northstar/prerequisites#cgnat) - ## If server is not reachable using external IP nor using internal IP Try checking your loopback network interface `http://127.0.0.1:{server_tcp_port}/verify` -#### Another program is using the port +### Another program is using the port Sometimes another program listens to the same tcp port as Northstar. @@ -71,6 +71,6 @@ You can check if that's the case by running `netstat -a -b` using CMD as admin As two programs cannot listen to the same port and IP at the same time, changing the TCP listen port can sometimes solve the problem. -#### Server is using the wrong port +### Server is using the wrong port You can use `netstat -a -b` using CMD as admin to check which process listens on which port diff --git a/docs/installing-northstar/basic-setup.md b/docs/installing-northstar/basic-setup.md index 753cfdb..d82f493 100644 --- a/docs/installing-northstar/basic-setup.md +++ b/docs/installing-northstar/basic-setup.md @@ -18,11 +18,11 @@ Firstly, note that the Northstar client is only available on PC and requires you Usually: `C:\Program Files\EA Games\Titanfall2` 3. Launch `NorthstarLauncher.exe` to start Northstar * After launching for the first time, you'll be greeted with a popup requesting to authenticate to the master server. Click _Yes_ (This can be changed in the mods menu later if desired)\ - ![](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/titleagreement.png) + ![Authentication Agreement](/docs/images/titleagreement.png) 4. Select _Launch Northstar_\ - ![](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/titlelaunchnorthstar.png) + ![Launch Northstar](/docs/images/titlelaunchnorthstar.png) 5. From the multiplayer menu, you can use the server browser to select and join any of the public community hosted servers.\ - ![](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/lobbyserverbrowser.png) + ![Server Browser](/docs/images/lobbyserverbrowser.png) Should you notice any issues/warnings/errors while running Northstar, check the troubleshooting page. diff --git a/docs/installing-northstar/using-northstar/commands.md b/docs/installing-northstar/using-northstar/commands.md index 43e428e..4284e47 100644 --- a/docs/installing-northstar/using-northstar/commands.md +++ b/docs/installing-northstar/using-northstar/commands.md @@ -1,6 +1,6 @@ # Commands -### Opening the Console +## Opening the Console Commands are run on the console. To open it, press `` ` `` (the key above `TAB`).\ Note that this key generally only exists in this form on English keybords (ANSI US, ISO UK, ...). @@ -12,13 +12,13 @@ To open your console you'll either have to switch to the English (US) layout **b To rebind it make sure neither Titanfall nor Northstar are running, then go to `My Documents\Respawn\Titanfall2\local\` and open `settings.cfg`.\ Look for the line containing `toggleconsole`, i.e. -``` +```txt bind "`" "toggleconsole" ``` and replace the `` ` `` key with your prefered key to open console. So if you want to open console with `F5`, change the line to -``` +```txt bind "F5" "toggleconsole" ``` @@ -43,6 +43,7 @@ In the future this keybind should hopefully be adjustable via `Controls > Settin | `r_latencyflex` | Enables [LatencyFleX](../../using-northstar/playing-on-linux/#latencyflex) (Linux-only, enabled by default) | `0` / `1` | ### Useful dev commands + Requires `sv_cheats 1` Command|Result diff --git a/docs/installing-northstar/using-northstar/gamemodes.md b/docs/installing-northstar/using-northstar/gamemodes.md index 9944e03..17fd52c 100644 --- a/docs/installing-northstar/using-northstar/gamemodes.md +++ b/docs/installing-northstar/using-northstar/gamemodes.md @@ -41,5 +41,3 @@ Complex, Forwardbase Kodai, and Colony have had control panels added with [the v ## Competitive CTF CTF with custom settings for Comp games. - - diff --git a/docs/installing-northstar/using-northstar/mods.md b/docs/installing-northstar/using-northstar/mods.md index 07728c3..bce2c4e 100644 --- a/docs/installing-northstar/using-northstar/mods.md +++ b/docs/installing-northstar/using-northstar/mods.md @@ -2,8 +2,7 @@ ![Northstar Mods](https://user-images.githubusercontent.com/7439692/146625579-20586c9e-2e23-4c5d-ba56-27b6eb1ffff4.jpg) - -## Pre-installed mods: +## Pre-installed mods Northstar by default comes with 3 mods installed. They are located in the `Titanfall2\R2Northstar\mods` folder. You can access these from the `Mods` menu at the bottom of the main menu. @@ -11,8 +10,10 @@ Northstar by default comes with 3 mods installed. They are located in the `Titan - **Northstar.Custom** - Additional gamemodes and weapons for the game, such as Fastball, Titan Tag, Infection, and Hide and Seek. - **Northstar.CustomServers** - The basic mod for hosting servers with additional match settings -## Community created mods: +## Community created mods + Northstar additionally has many mods that are created by members of the community which are avaliable on the [Northstar Discord](https://northstar.tf/discord). They can be found in the following channels: + - `#northstar-client-mods` for client-side only mods like HUD changes, skins, etc. - `#northstar-server-mods` for mods that primarily target servers, like new gamemodes, moderation tools, etc. diff --git a/docs/installing-northstar/using-northstar/playing-on-linux.md b/docs/installing-northstar/using-northstar/playing-on-linux.md index c1c0fc2..ecdf81d 100644 --- a/docs/installing-northstar/using-northstar/playing-on-linux.md +++ b/docs/installing-northstar/using-northstar/playing-on-linux.md @@ -17,29 +17,30 @@ Linux is not officially supported currently. However, you can get it working thr Now Steam will automatically launch Northstar when you hit play. Just launch the game through Steam and you should be greeted with a Northstar welcome message upon entering the main menu. > **Note:** There is a current bug where the game would sometimes launch vanilla Titanfall 2 instead of Northstar. There is no universal fix for this, but people have reported changing Proton versions to _Proton 5.13_ or _Proton Experimental_ and deleting the Proton prefix folder (`Steam/steamapps/compatdata/1237970/`) could help resolve this issue. Using [Proton GE](https://github.com/GloriousEggroll/proton-ge-custom) has also been reported to resolve the issue. - +> > If you are still suffering from this bug, try running the game through Lutris. The bug doesn't seem to happen there ### Lutris (Wine) -1. If you don't already have the game downloaded, install the game [from here.](https://lutris.net/games/titanfall-2/) +1. If you don't already have the game downloaded, install the game [from here.](https://lutris.net/games/titanfall-2/) 2. Download the latest version of Northstar from the [releases](https://github.com/R2Northstar/Northstar/releases) page 3. Extract all contents of the file to your Titanfall 2 folder 4. **If you have the game installed on Lutris:** right click _Titanfall 2_ > _Configure_ > _Game Options_ > Set _Executable path_ to _NorthstarLauncher.exe_ -5. **Otherwise:** click the `+` button in the top left > set the name to whatever and _Runner_ to _Wine_ > click on _Game options_ > set _Executable path_ to _NorthstarLauncher.exe_ then save. +5. **Otherwise:** click the `+` button in the top left > set the name to whatever and _Runner_ to _Wine_ > click on _Game options_ > set _Executable path_ to _NorthstarLauncher.exe_ then save. -> **If you're migrating from Steam:** Set _Wine prefix_ to `(your Steam directory)/steamapps/compatdata/1237970/pfx/`. This will save you the hassle of having to re-download Origin. +> **If you're migrating from Steam:** Set _Wine prefix_ to `(your Steam directory)/steamapps/compatdata/1237970/pfx/`. This will save you the hassle of having to re-download Origin. Now just launch the game through Lutris and you should be greeted with a Northstar welcome message upon entering the main menu. > **Note:** Origin might prompt you to log in and "set an installation folder for future downloads" on first launch. Just do those, close Origin, then launch the game again. - +> > You might feel the game is stuttering a lot in the first hour of playing. This is normal, it's just DXVK is compiling shaders. The more you play, the less you will stutter in the future. Someone on discord wrote [an in-depth guide](https://i.imgur.com/xzop1lQ.png) on good settings to help the shader cache **and a general performance boost by stopping Origin from writing unnecessary files**.\ > [Link to cache](https://github.com/Cervoxx/DXVKCACHE/raw/master/Titanfall2-cache.tar.xz)\ > [Link to Origin being slow discussion](https://github.com/ValveSoftware/Proton/issues/4001#issuecomment-647014231) ## LatencyFleX + LatencyFleX is a Linux-only input latency reduction alternative to Nvidia Reflex that is supported by Northstar. Currently, LatencyFleX requires manual installation. A full install guide and current releases [can be found on their GitHub](https://github.com/ishitatsuyuki/LatencyFleX). Northstar only requires the [Vulkan layer](https://github.com/ishitatsuyuki/LatencyFleX#latencyflex-vulkan-layer-essential) and [Wine extensions](https://github.com/ishitatsuyuki/LatencyFleX#latencyflex-wine-extensions-required-for-proton-reflex-integration) steps to be completed. @@ -49,7 +50,7 @@ Once installed, LatencyFleX can be enabled by doing either of the following: - **Steam:** Add the following to your Titanfall 2 launch options: `"LFX=1 %command%"` - **Lutris:** Right click on Titanfall 2, click 'Configure', navigate to 'System Preferences' / 'System Options' / 'Environmental Variables', and use the following: -> Key: LFX +> Key: LFX Value: 1 Once in-game, LatencyFleX can be toggled off and on using the `"r_latencyflex"` console variable. @@ -82,4 +83,4 @@ Some users have reported issues with enabling LatencyFleX. If you see `"Unable t ### Game crashes on launch with Cause: Access Violation Data Execution Prevention (DEP) at: 0x00000000 -try running with ProtonGE https://github.com/GloriousEggroll/proton-ge-custom/. +try running with [ProtonGE](https://github.com/GloriousEggroll/proton-ge-custom/). diff --git a/docs/modding/README.md b/docs/modding/README.md index 5b9a9a2..ab4dac3 100644 --- a/docs/modding/README.md +++ b/docs/modding/README.md @@ -2,13 +2,14 @@ Usefull resources created by the community to help you start modding: -* NoSkill modding guide - [https://noskill.gitbook.io/titanfall2/](https://noskill.gitbook.io/titanfall2/) -* All the Squirrel Constants - [https://gist.github.com/laundmo/825c4708663a179b23e144402b09244f](https://gist.github.com/laundmo/825c4708663a179b23e144402b09244f) -* Modding Documentation - [https://github.com/ScureX/Titanfall2-ModdingDocumentation#readme](https://github.com/ScureX/Titanfall2-ModdingDocumentation#readme) -* Squirrel Highlighting for Npad++ and VSCode - [https://gist.github.com/samisalreadytaken/5bcf322332074f31545ccb6651b88f2d](https://gist.github.com/samisalreadytaken/5bcf322332074f31545ccb6651b88f2d) -* List of Console Commands - [https://pastebin.com/raw/3DSCK09f](https://pastebin.com/raw/3DSCK09f) -* Useful Squirrel - [https://faithful-piper-52c.notion.site/Useful-Squirrel-2300bc55141e4bee85b8c7dc8afffbc9](https://faithful-piper-52c.notion.site/Useful-Squirrel-2300bc55141e4bee85b8c7dc8afffbc9) -* List of squirrel funcs available to dedicated server with their signatures - [https://gist.github.com/laundmo/a6ee0692ae137876b7514c0f4a57df4b](https://gist.github.com/laundmo/a6ee0692ae137876b7514c0f4a57df4b) -* Native registered script functions, they are from Season 3 Apex but most also exist on Titanfall 2, especially the Titan functions. Also includes description for each function if the developers have given it one - [https://github.com/kawainekome/ApexLegends_S3_Squirrel_Registered_API_SimpleDoc](https://github.com/kawainekome/ApexLegends_S3_Squirrel_Registered_API_SimpleDoc) +* [NoSkill modding guide (highly recommended to check out)](https://noskill.gitbook.io/titanfall2/) +* [Tools for modding](tools.md) +* [All the Squirrel Constants](https://gist.github.com/laundmo/825c4708663a179b23e144402b09244f) +* [Modding Documentation](https://github.com/ScureX/Titanfall2-ModdingDocumentation#readme) +* [Squirrel Highlighting for Notepad++ and VSCode](https://gist.github.com/samisalreadytaken/5bcf322332074f31545ccb6651b88f2d) +* [List of Console Commands](https://pastebin.com/raw/3DSCK09f) +* [Useful Squirrel](https://faithful-piper-52c.notion.site/Useful-Squirrel-2300bc55141e4bee85b8c7dc8afffbc9) +* [List of squirrel funcs available to dedicated server with their signatures](https://gist.github.com/laundmo/a6ee0692ae137876b7514c0f4a57df4b) +* [Native registered script functions](https://github.com/kawainekome/ApexLegends_S3_Squirrel_Registered_API_SimpleDoc), they are from Season 3 Apex but most also exist on Titanfall 2, especially the Titan functions. Also includes description for each function if the developers have given it one Check [the next page](getting-started.md) to get started. diff --git a/docs/modding/getting-started.md b/docs/modding/getting-started.md index 7c81961..248cf07 100644 --- a/docs/modding/getting-started.md +++ b/docs/modding/getting-started.md @@ -6,17 +6,15 @@ This guide assumes you have basic understanding with programming and know how to If you'd like a more lengthy set of tutorials covering many topics. Look at: -{% content-ref url="modding/tutorials/modding-tutorials.md" %} -[modding-tutorials.md](modding/tutorials/modding-tutorials.md) +{% content-ref url="/docs/modding/tutorials/modding-tutorials.md" %} +[modding-tutorials.md](/docs/modding/tutorials/modding-tutorials.md) {% endcontent-ref %} -> TODO: Actually link tools +You can check out all the tools for modding Titanfall 2 here: -### Tools - -* RSPNVPK -* Cra0 VPK Tool (Titanfall VPK Tool) -* Legion by DZXTPorter +{% content-ref url="/docs/modding/tools.md" %} +[tools.md](/docs/modding/tools.md) +{% endcontent-ref %} ## Quick start diff --git a/docs/modding/keyvalues.md b/docs/modding/keyvalues.md index e69de29..3a5b08c 100644 --- a/docs/modding/keyvalues.md +++ b/docs/modding/keyvalues.md @@ -0,0 +1,12 @@ +# Changing keyvalues (weapons) + +Do keep in note that this is usually changed server-side. + +To actually change the keyvalues of weapons you'd have to name them appropriately inside a mod folder\ +For example: `R2Northstar\mods\Northstar.Custom\keyvalues\scripts\weapons`\ +You can find all the weapon keyvalues [here](https://github.com/BigSpice/TitanFall_2_Weapon_Skin_Modding/tree/main/Weapon_Scripts) + +- Mod Examples: + - [Northstar.Custom](https://github.com/R2Northstar/NorthstarMods/tree/main/Northstar.Custom) + - [Unholy Trinity](https://github.com/xamionex/xamionex.UnholyTrinity) + - [Kraber9k](https://github.com/Steveplays28/kraber9k/tree/main/Steveplays.Kraber9K) diff --git a/docs/modding/tools.md b/docs/modding/tools.md new file mode 100644 index 0000000..4049338 --- /dev/null +++ b/docs/modding/tools.md @@ -0,0 +1,68 @@ +# Modding Tools + +## Source Engine + +### Titanfall + +* [Titanfall VPK Tool](http://cra0kalo.com/public/Titanfall\_VPKTool3.4\_Portable.zip) +* [Legion](https://wiki.modme.co/wiki/apps/Legion.html) + +### RPSNVPK's + +* [squidgyberries RSPNVPK](https://github.com/squidgyberries/RSPNVPK) +* [taskinoz RSPNVPK](https://github.com/taskinoz/RSPNVPK) +* [Provoxin RSPNVPK](https://github.com/Provoxin/RSPNVPK-GUI) + +{% embed url="https://noskill.gitbook.io/titanfall2/how-to-start-modding/modding-introduction/modding-tools/how-to-use-rspnvpk" %} +NoSkill: How to use RSPNVPKs +{% endembed %} + +### VTF & VMT + +* [VTFEdit](https://developer.valvesoftware.com/wiki/VTFEdit) +* [VTF Shell Extensions](https://www.wunderboy.org/valve-hl2source-sdk-tools/#vtf\_shell) - [Info](https://developer.valvesoftware.com/wiki/VTF\_Shell\_Extensions) + +## Other utilities + +### File editor + +* [Atom Text](https://atom.io) + * [Syntax color KeyValue](https://atom.io/packages/language-source-cfg) + * [Syntax color Squirrel](https://atom.io/packages/squirrel-language) + * [Color picker](https://atom.io/packages/color-picker) +* [TextCrawler 3](https://www.digitalvolcano.co.uk/tcdownloads.html) +* [Visual Studio Code](https://code.visualstudio.com) +* [Notepad++](https://notepad-plus-plus.org/downloads/) + +### Graphics / animation / color editors + +* [Paint.net](https://www.getpaint.net) + * [Gradient Mapping plug-in](https://forums.getpaint.net/topic/6265-gradient-mapping/) + * [Animation Helper](https://pixelbyte.itch.io/paint-net-sprite-plugin) +* [Source VMT Color](https://dev.cra0kalo.com/?p=155) +* [GIMP](https://www.gimp.org/downloads/) + * [VTF plug-in](https://www.tophattwaffle.com/downloads/gimp-vtf-plugin/) +* [RGB Tool converter](http://hewmc.blogspot.fr/2012/12/rgb-to-percentage-converter.html) +* [Color Pick Windows](https://pixelbyte.itch.io/color-pick) +* [GIF splitter](https://ezgif.com/split) +* [Rad Tools Bik](http://www.radgametools.com/bnkdown.htm) (needs [Quicktime 7.6](https://support.apple.com/downloads/quicktime)) + +### Archives + +* [7zip](https://www.7-zip.org) + +### Driver editors + +* [NVidia Profile Inspector](https://nvidia-inspector.en.lo4d.com/windows) +* [ATI Radeon Tray Tools](https://www.majorgeeks.com/files/details/ati\_tray\_tools.html) + +## 3D Models + +* [Blender](https://www.blender.org) + * [Blender Source Tool](https://developer.valvesoftware.com/wiki/Blender\_Source\_Tools) + * [Blender VMT](https://github.com/lasa01/blender-vmt) + * [io import VMF & VMT](https://github.com/lasa01/io\_import\_vmf) +* [Crowbar](http://steamcommunity.com/groups/CrowbarTool) +* [Ninja Ripper v1.7.1](https://gamebanana.com/tools/5638) + +Highly recommended to check the [NoSkill Gitbook modding section](https://noskill.gitbook.io/titanfall2/how-to-start-modding/modding-introduction/modding-tools) for more tools. |