| Uploading through a script |
ckknight |
ckknight |
16 Apr 2009 |
| If you want to automate your uploading process through CurseForge, there is a way to do this properly: Getting your API Key First, you must go to http://www.curseforge.com/home/api-key/ and generate an API key if you have not already. This is unique to you and provides you a way to authenticate through scripts without a complex login process. Figuring out your game versions Next, for the game you want, you're going to want to calculate what game versions you support, knowing the backend ID.... |
| .docmeta file |
ckknight |
Ackis |
19 Mar 2009 |
| For your repositories, you can put a '.docmeta' file in to provide extra information. Yes, that is a dot followed by 'docmeta'. .docmeta is a YAML file that goes in the root of your repository project folder. This means /trunk/.docmeta for SVN users and /.docmeta for Git and Hg users. Remember to use spaces instead of tabs for indentation Your .docmeta file, if it exists, will be validated when you commit. Documentor status The status of the documentor may be viewed at... |
| .pkgmeta file |
ckknight |
Arrowmaster |
10 Nov 2009 |
| Location of the file For your repositories, you can put a '.pkgmeta' file in to provide extra information. Yes, that is a dot followed by 'pkgmeta'. .pkgmeta is a YAML file that goes in the root of your repository project folder. This means /trunk/.pkgmeta for SVN users and /.pkgmeta for Git and Hg users. Remember to use spaces instead of tabs for indentation in the file Your .pkgmeta file, if it exists, will be validated when you commit. Creating the file On some OSes (Windows for example)... |
| Changing Descriptions |
ckknight |
ckknight |
05 Mar 2009 |
| The description of your project is actually tied into the Pages system. Thus, to edit the description of your project, you merely have to edit the Main page of your project. Click on the page on your project, and choose Page Actions -> Edit Page. If you'd like to add a description that isn't English, what you should do is create a page (Project Actions -> Create Page) with the name Main and the language of your choice. |
| Cloning |
ckknight |
ckknight |
05 Mar 2009 |
| Cloning is a mechanism to allow for developers who are not authors on a project to work on a project, fix defects, add enhancements, or take it in a completely different direction. Cloning is only available on projects that meet The Open Source Definition or projects where the author specifically allows it. Cloning is somewhat of a middle-ground between branches and forks. Branch The owner of the project must authorize this by making the curious developer an actual author on the project. It's... |
| Getting started with Project Management |
Zyuu |
ckknight |
05 Mar 2009 |
| This guide's sole purpose is to guide you through the steps on how to create and upload your projects to CurseForge; giving your projects maximum exposure. Creating a Project 1) Click "Create Project" in the menu. Chose a game, World of Warcraft or Warhammer: Age of Reckoning are two popular games, but we support any game that allows mods. 2) You're now presented with several fields: Name: This is the name of your project, example: Cartographer. Remember that you can't change your name... |
| Localizing your project |
ckknight |
Nevcairiel |
10 Mar 2009 |
| Whether you want to localize an existing project or are starting a new project, we provide a few nice mechanisms to make things easier on everyone, from developers to translators. To start off, you're going to want to set up the localization on your project. Go to your project's detail page, and under actions, you'll see "Setup localization" (your project URL will now be something like http://wow.curseforge.com/projects/project/setup-localization/ or... |
| What to do after creating a project |
ckknight |
Arrowmaster |
08 Sep 2009 |
| Getting approval Before other users can see your project and before it reaches curse.com, an admin has to approve your project. If everything works out fine, you just need to wait and it'll all be good. See Project Acceptance Policy for more details. Editing your project's description You might want to provide more information in your description, add a feature to a feature list, etc. To do this, see Changing Descriptions Uploading images/screenshots This is a pretty simple process. Take a... |
| File Statuses |
Ackis |
Ackis |
16 Apr 2009 |
| This document will outline what the file statuses for files, and what you can do to fix them. .DS_Store .DS_Store means that you have included .DS_Store files/folders/directories in the zip file. To correct this, remove the .DS_Store files from the zip and re-upload, or zip with the following command: zip -r "$1" "$1" -x \*.DS_Store _MACOSX _MACOSX means that you have included _MACOSX files/folders/directories in the zip file. To correct this, remove the _MACOSX files from the zip and... |
