Skip to content
This repository has been archived by the owner on Jul 24, 2023. It is now read-only.

Latest commit

 

History

History
70 lines (47 loc) · 2.59 KB

readme.md

File metadata and controls

70 lines (47 loc) · 2.59 KB

Upgrade Shop

Join Our Discord

About

A simple "F to Upgrade" custom gamemode for Overwatch, written in OWScript.

Current Gamemode/Workshop Code

You can find the most recent code on our Discord or Overwatch forums post.

Links

Overwatch Forums Post

Trello Board

Discord

Developer Stream

Development

Pre-Requisites

  • Sublime Text 3, if you want the officially supported syntax from OWScript
  • Python >= 3.6

Cloning the Repo

Since Upgrade Shop utilizes submodules you have to also clone the submodules.

 git clone --recurse-submodules repoURL

Understanding the File Structure

dist/

The folder that contains the output gamemode, mainly committed to ensure there's no errors during the compile process.

OWScript/

A submodule linked to OWScript to make the development process consistent and easier.

src/

The main source directory for the gamemode.

src/modules/

The folder containing all the git submodules that are used throughout the gamemode.

src/lib/

The "library" (or collection) of all the source files that are used in the gamemode. The "meat" of the project is in here. Most things are self-explanatory or have corresponding documentation in them.


Submodules

If you're new to submodules, you can read about them here on the official Git website. Upgrade Shop utilizes submodules for OWScript and modules that are imported into the gamemode.


Compiling

Compiling is SUPER easy, assuming you've . All you have to do is is execute compile.sh. If no errors are present, it will output the script to dist/shop.ows.


Testing

Just copy and paste the code from dist/shop.ows to your Overwatch workshop screen. Although, you should use the latest workshop code as a base and modify the workshop code itself from that.


Watcher

I've "written" (thanks Stack Overflow and GitHub gists) a script for PowerShell that watches all the *.owpy files and on change, it will recompile. Only supports Windows currently.

OWScript

This project is proudly written in and supports OWScript. If you're interested in working on Overwatch custom gamemodes and want a simple, yet elegant, way to get started I highly suggest OWScript.