Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 4.96 KB

README.md

File metadata and controls

83 lines (50 loc) · 4.96 KB

Microgames in TF2 // microtf2

A custom gamemode for Team Fortress 2 - Players compete against each other to get the most points by playing a series of rapid fire microgames in order to win the round!

GitHub Downloads (all assets, all releases) GitHub Actions Workflow Status

Interested in what's next? View our kanban board: https://github.com/orgs/gemidyne/projects/5/views/1?sliceBy%5Bvalue%5D=v6

How to install the gamemode

We have created an install guide to help you install the gamemode - see wiki page here: https://github.com/gemidyne/microtf2/wiki/How-to-install-the-gamemode

Commands

See wiki page for more information: https://github.com/gemidyne/microtf2/wiki/Console-Commands

Console Variables

See wiki page for more information: https://github.com/gemidyne/microtf2/wiki/Console-Variables

Repository info

The /src folder contains the plugin source-code. The /assets folder contains data relating to the map, plugin overlays and sounds. It is strongly recommended that you use https://www.gemidyne.com/projects/tsukuru/ to build the map and pack in the necessary assets.

The "master" branch is the latest stable version of the gamemode. We recommend you use this branch on your game servers. The "dev" branch is used for the latest development version of the gamemode. This branch contains work in progress projects so may be uncompilable, untested and not be the best experience for your players. We recommend you use the master branch over the dev branch.

SourceMod Extension / Plugin Dependencies

The gamemode utilises the following extensions and plugins to run:

If you intend to use the SDK plugin for developing your own gamemodes or minigames, you will need:

Map Development

The map's master VMF file lives in /assets/warioware_redux_master.vmf - we use https://www.gemidyne.com/projects/tsukuru/ to build dev & release versions of the map and pack in data. You can import our map compile settings into Tsukuru by importing the warioware_redux_master.tsumc in the /assets/ folder - and then fix the file paths to be correct for your repository path.

Our workflow for dev maps / release maps is to pack all necessary data into the BSP file, and then repack the BSP file. You can do all this by using Tsukuru. Packing all sounds, textures, models into the BSP file and repacking it means players will only need to download a single file to play the gamemode.

We use Hammer++ for map development, as this version of Hammer has many fixes over the stock version of Hammer bundled with TF2.

Contributing

Testing

We appreciate your interest in wanting to help test the gamemode. We have a tester group on Steam Community where we will be communicating test sessions. The group chat within this steam group is where we will communicate upcoming test sessions due to Steam's broken event functionality.

Steam Group

Join Steam Group Chat

Translations

We'd love to have you on board! If you are interested in contributing translations, there are two ways you can do it:

  1. We can add you onto our gemidyne.com Translator Tool which makes editing translations super quick and easy - click this link and choose Become a translator.
  2. You can add your own language "microtf2.phrases.txt" file built from the english file into your own translation folder - this way is more manual but you can contribute via pull requests if you want

We currently have translators for the following languages:

  • French
  • Italian
  • Spanish
  • Russian
  • Portuguese
  • Brazilian Portuguese
  • Polish
  • German

Credits

View the full gamemode credits here: https://www.gemidyne.com/projects/microtf2/credits

Disclaimer

Microgames in Team Fortress 2 is a fan project and is strictly not for profit. All logos and brands are property of their respective owners.