Maximus F.A.Q.
Below is a list of frequently asked questions concerning Maximus.
- What is Maximus?
- Maximus is a module manager for BlitzMax. Maximus is made out of 2 parts. The first is this website, a place to host your BlitzMax modules. The website is responsible for supplying module packages to the Maximus client. The client is used to install and manage installed modules on your computer. The client is cross-platform compatible and is available for Windows, Mac OSX and Linux. Both the website software and the client are open-source and licensed under the MIT license.
- What features does the website have?
- Through the website it's possible to do the following things:
- Download BlitzMax modules
- Fetch a sources file which contains all hosted modules, including dependencies. This file is available in JSON and XML.
- Upload modules; you can provide a ZIP-file and Maximus figures out what to do with it.
- Manage your uploaded modules
- Let Maximus use the auto-discover function on your SCM hosted repository to auto-detect all modules hosted inside that repository. Auto-discovery is designed to work with multi-module (and multi-modscope!) repositories. Currently only Git and Subversion are supported. But more support for other SCM software is on the way.
- Let Maximus check your SCM repositories for updates and automatically generate new packages if there are any updates. Depending on the SCM software you use (e.g. Git) you can specify global settings (such as a tag filter) or specify them per module (for Subversion this means specifying trunk and tags path).
- What features does the client have?
- Please visit our client page for more information about the client.
- Who is we?
- The Maximus team. Founded by Plash (a.k.a. Komiga) and Htbaa. Plash however is no longer doing any active development. He did however write the biggest part of the client and his contributions are very much appreciated.
- Who designed this website?
- The website was kindly designed by skn3.
- Is there also a official Wiki?
- Certainly! We have a Wiki hosted at GitHub.
- Can I follow progress on Twitter?
- Yes! We'll be using @maximusweb for that. Newly uploaded modules are announced there too.
- Installed modules contain a meta.maximus file, what is it?
- Maximus has to track which modules it installed to decide which modules it can update, and which ones to leave alone. This way Maximus will only modify modules that have been installed by itself. Manually installed modules (outside of the client) won't be upgraded.
- If you're a module author be sure you don't add this file yourself! Otherwise Maximus might alter your work. Aside from that, using Maximus will be perfectly save with your own SCM managed modules. That being said, use it at your own risk.
- Where can I find the source code for Maximus?
- Both the website repository and client repository are hosted on GitHub. You are welcome to contribute.
- How can I contact the developers or contribute to the project?
- Drop by on IRC: irc.blitzed.org/maximus. By the way, #blitzbasic is also on the very same server!
- If you want to contribute you are free to fork the projects on GitHub. Please do so if you notice small errors. If you want to add new features please do discuss this with the development team first. Take a look at our Get Involved page as well.
- Maximus is also listed on OpenHatch.
- What's up with asking for donations? Is someone planning to get rich of this?
- Nope, every penny that comes in will be used to pay the bills for running this service. You can find more information about the campaign on the Pledgie website.
- Current status of the campaign:
