Giter Club home page Giter Club logo

compatibilityreport's Introduction

Compatibility Report v2.3.0

Compatibility Report mod for Cities: Skylines. This reports compatibility issues and missing dependencies for your subscribed mods.

Current status

This mod is available on the Steam Workshop. This is the official continuation of the Compatibility Report by Finwickle and Mod Compatibility Checker by aubergine.

Implemented features

  • Detection of subscribed and local mods.
  • Gzipped XML catalog with basic mod information and compatibility information. The Mods itself includes the most actual catalog. No need for side downloads and no issues with download limits or non accessible storage any more.
  • Review of subscribed mods with the catalog information.
  • HTML and/or text report, sorted by mod name. Split into multiple categories, based on issue severity.
  • Mod options for easy access to reports, catalog download, feedback via report-form or on discord, links to recommended mods and also broken mods.
  • Button to create a .zip file with most important logs for support that will be stored on desktop.
  • Support for mod groups, to allow different editions (e.g. stable and test) of mods as mod requirement.
  • Basic translation frame work (UI and catalog standard fields. Languages for notes will be integrated later)
  • Catalog Updater method (for mod maintainers only), based on web crawling the Steam Workshop and CSV import.
    • Automatically detects new mods and changes in mod information: name, required DLC/mods, source URL, ...
    • Easy catalog maintenance with simple CSV files for updated mod and compatibility information. This allows for catalog maintenance by multiple people.
    • Automatic change notes and catalog versioning.
    • Dedicated UI for easier maintenance.

Roadmap and future ideas

The roadmap towards version 2.1 and the future ideas will be listed here:

Credits

This mod is based on Compatibility Report by Finwickle and uses code from Mod Compatibility Checker by aubergine. It also uses code snippets from:

  • Enhanced District Services by chronofanz a.k.a. Tim (GitHub)
  • Change Loading Image 2 by BloodyPenguin (GitHub)
  • Loading Screen Mod by thale5: (GitHub)

Special thanks to:

  • krzychu124 for doing the coding part that where needed to come to v2.
  • Finwickle for his great work on the first version of this mod and all the hours he also spent in testing mods! It's a honour for me to continue your work!
  • Aubergine for the awesome MCC mod.
  • John Rambo, for his contribution to the code.
  • BloodyPenguin, Tim and thale5 for publishing the source code of their mods, from which some code is used.
  • AquilaSol and Avanya for their famous Broken/Incompatible Mod list, i've the honour to participate my knowledge into too. All information from that document is included in this mod.
  • Everyone who provided feedback in a comment, by the Google form, on GitHub, on discord or supported me with a donation!

Also thanks to:

  • All modders for their great and often game-changing mods, and the hard work they put into them. And for sharing their source code for re-use and education.
  • All modders and mod users that share their feedback and report their issues in the comments for all mods on the Workshop.
  • All above and many others for providing a friendly atmosphere on Discord.

Disclaimer

Life happpen, errors happen - so if you see one, please feel free to contact me.

compatibilityreport's People

Contributors

cactooz avatar chameleon-tbn avatar cmircea avatar finwickle avatar krzychu124 avatar quboid avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.