Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 2.07 KB

File metadata and controls

25 lines (20 loc) · 2.07 KB

Contributing Guide

Welcome to OpenVic! We are thrilled that you want to help us build this project. Whether you are writing docs, testing, reporting bugs, or implementing mechanics, every contribution makes a massive difference.

About OpenVic

OpenVic aims to faithfully recreate Victoria 2: Heart of Darkness with a focus on enhancing performance, stability, and modability. We will support loading Victoria 2 mods with zero modifications in a classic / compatibility mode, which will be available if you own a legitimate copy of Victoria 2. OpenVic's default mode will be completely free, with our own graphics, content, data, and soundtrack, keeping the overall feel, playstyle, and balance as Victoria 2. OpenVic will have its own modding API, allowing for extremely detailed and deep mods, while being easier to mod and easier for users to find and install mods.

Communication

Most team communication happens on the Discord.

Required Reading

Further Reading

Finding a First Task

We want to make your first contribution as smooth as possible.

  • Review the Documentation: Improving guides, fixing typos, researching Victoria II mechanics, or improving code documentation are all excellent ways to familiarise yourself with the codebase and make a first contribution, no fix is too small!
  • Join the Discord: Drop by our Discord and ask where help is currently needed. Maintainers are happy to pair you with a task that matches your skills and interests.
  • Check Open Issues: Issues marked as a "good first issue" are a great place to start if you feel ready to dive right in. Please comment on an issue to let us know you're working on it, or let us know in the Discord to avoid any duplication of work.