Ok, I'm going to post the OJP readme here so people can see what we're already come up with from the previous decisions on the subject.
===================
0001 - Introduction
===================
The Open Jedi Project is a coding/modding collaboration with the intent of maximizing the features and fun factor for all Jedi Knight Academy (JKA) mods. We work together by contributing fun, interesting, and useful game features so that everyone can benefit.
We operate on what's basically an open source system. Open source basically means that the source code is freely available and accessible by all. See the "Using Our Work" section for details about rights and permissions.
Our design philosophy is to make everything as separated and customizable as possible to allow developers and players to choose what features they wish to use.
We currently have two distributions (gameplay/code changes), Basic and Enhanced. We also have two packs (non-gameplay related), Vehicles and Skins.
Basic has two main features. One is bug fixes and balance fixes, neither which will severely alter game play. They are designed to be the "unofficial patch" for bugs and game play problems. Basic can still be considered vanilla Jedi Academy. The other main feature is map enhancements. Things such as new entities, expanded AI, vehicles, scripting and effects system can allow mappers to create far more immersive and fun maps. Since Basic also aims towards recreating all the single player entities and code, it is possible for mappers to create full featured cooperative and single player games and levels using the multiplayer engine. This allows modders to make other enhancements such as new weapons, AI, etc., not possible using the single player engine.
Enhanced is a superset of Basic, meaning it has anything and everything included in the Basic distribution. The difference is that it adds many significant gameplay alterations. It is a playable mod, but also a code base for other developers. To decrease the possibility of mods based off Enhanced loosing originality, we are keeping our game play feature list generic and flexible. New features will be generic, expandable, and flexible so other developers can easily adopt them to their mods. It won't venture out side of Jedi Academy's principle game play, so there won't be anything that makes this drastically unique in terms of pure game play. Players get a full mod that shares the same basic principles and ideas that stock Jedi Academy offers. Developers get a solid, flexible code base that includes the basic, fundamental features you would want to find in most mods, allowing them to spend their time on what makes their work truly unique. An example of a feature for Enhanced would be an extended version of the player class system seen in Siege, one that is available in more game types, and is far more flexible.
The Vehicles package is a collection of additional vehicles for JKA. We're including them in the project to allow OJP compatible maps to use additional vehicles without having to include said vehicles in their release packages.
The Skins package is a collection of quality modder created skins that have been turned
into customizable player classes. We've done this to allow more player options, to
allow SP useage of these skins, to allow servers and players to quickly get a pack of
quality skins, and to prevent a lot of redundent data from clogging up your game
directory.
We have a web forum set up for OJP. You can find it at...
http://www.lucasforums.com/forumdisplay.php?s=&forumid=542)
We have a website pending. Please be patient.
=====================
0005 - Using Our Work
=====================
We have few rules for using our work as part of your own projects:
- You must include this readme in any public releases of your mod. This doesn't apply if you're only using OJP features that you wrote yourself.
- You must treat your fellow coders and the project with respect.
- You may NOT use our work for ANY commercial purposes without the author's direct permission.
Please don't violate these rules; they are here for everyone's benefit.
We have a public CVS repository set up to let you directly access the OJP source materials to keep up-to-date with latest additions to the project. However, the process to access the repository is a bit complicated, so please email one of the moderators for assistance.
In addition, we are still waiting for the MP SDK so there will probably not be anything to see for a while anyway.
We suggest that you:
- Submit any cool features from your work that you think other developers may benefit from.
- Keep in contact with us about your project. The more information we have, the better we can coordinate OJP to help you and the community. We also like to know that people are using and enjoying our works.
==============================
0006 - Submitting Stuff to OJP
==============================
We are looking mostly for new code features, but are not limited to that. We are usually looking for generic, flexible, and adaptable features that anyone can work into their own code. Features that are drastically unique or special probably do not belong here, because we believe in keeping individuality and uniqueness among mods.
We also accept patches. If you see something in our code that has a problem, you can submit a patch for it. A patch would usually be replacement code or files.
Before you consider submitting, take note that we won't let you desubmit or remove your works from the project. Allowing people to do so would cause too many problems for the project. While your work will remain your work, submitting stuff to OJP means that you give us the rights to use your work and modify it freely as part of the project forever.
In addition, your work won't necessarily be turned on or even in every compiled version of OJP. Some features will be disabled by default to allow people to just fire up and play OJP without confusion.
That being said, if you have something to submit just contact one of the OJP moderators.
DO NOT E-MAIL MOD MATERIALS TO STAFF MEMBERS WITHOUT ASKING FIRST! Just contact one of us, tell us a summary of your patch or feature, and if we think it fits the project, we'll accept it.
If you think you would like to actively participate in developing OJP, we can give you write access to the CVS repository, so that you may work on it yourself. This doesn't have to be a commitment, but if you would like to just submit features or patches separately, go ahead.
------------------------------
0006.1 - Submission Guidelines
------------------------------
- Document your work as much as possible. Be sure to add mentions of your work in the readme and other project documents.
- Make your work as clean and tight as possible.
- Follow the coding guidelines. Try to keep your code as separated from other code as is reasonable. Label EVERY coding change (from basejka) with appropriate coding tags. If you're creating a new feature, you'll get to determine what the tag name will be. Try to pick something that is simple and easy to search for.
- NEVER DELETE FILES/DIRECTORIES/ETC FROM THE CVS REPOSITORY. If it is necessary, the moderators will handle it.