You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
CedricH abb537c42b add shadowcaster on body, remove shadowcaster on windows_in 7 months ago
Assets Add icons psd assets 10 months ago
Sounds/BMW_2002Tii_sounds rename some dirs 8 months ago
Vehicles/BMW_2002Tii add shadowcaster on body, remove shadowcaster on windows_in 7 months ago
BMW_2002Tii.rfbuild rfbuild file is now prefixed with modname 8 months ago
INSTALL.md update doc 8 months ago
README.md update doc 8 months ago
buildme.bat add buildme.bat to build new rfcmp easily 8 months ago
sync-to-git.bat fix bat syntax error 8 months ago
sync-to-moddev.bat update tool files 8 months ago
sync.ini Add sync.ini file for sync-to scripts 1 year ago

README.md

Mod dev workflow purpose

This is a purpose for your mod development workflow:

  • track mod modifications with git
  • easier team development with git
  • test and validate your devs in rFactor2 moddev with sync_to_moddev.bat
  • rfcmp build automation with MAScompiler.exe

Install of the development directory

Install of the development directory is important before launching the .bat scripts and before building any new version !

See INSTALL.md

Usage

Do not be afraid of the workflow ! different operations are described in operations !

Workflow

Workflow

  • This repository contains all the needed source files of the BMW 2002 Tii for rFactor2.
  • This repository have to be cloned in a working directory outside of rFactor2 directory.
  • After cloning this repository, the sync-to-moddev.bat script will copy files of the BMW2002 Tii to moddev directory properly.
  • Each time you think that some modifications are ok, launch sync-git.bat script to copy files in moddev to your local git repository. In that way you will be able to view diffs, stage, commit, push... with git

Operation: get the code of the mod from the repository

It refers to 0. Pull mod files in the schema.

  1. Pull the code of the mod with Fork git client: click pull button in the Fork interface.

Operation: Modifying the mod

It refers to 1. Modifiy mod files / 3. Modify the mod files in the schema.

Modifying the code of the mod can be done in development directory or in the moddev directory. In each case you will have to synchronize the code between development directory and moddev directory:

  • When you want to test modifications in moddev after modifiying code in development directory: refer to Operation: Test in moddev
  • When you are happy of your tests in moddev, and maybe a new build can be done from: update development directory with modified code from moddev, refer to Operation: grab from moddev

Operation: Deploy mod in moddev

It refers to 2. Deploy to moddev in the schema.

  1. Launch sync_to_moddev.bat script: this will copy the code of the mod from your development directory to the moddev directory of your rFactor2 game

Operation: Grab mod from moddev

It refers to 5. Grab from moddev in the schema.

  1. Launch sync_to_git.bat script: this will copy the code of the mod from moddev directory to your development directory.

Operation: Build a new version of the mod

It refers to 6b. generate rfcmp.

  1. Build meta informations comes from sync.ini and .rfbuild files.

  2. Launch the script buildme.bat: the build version to build is then asked before building it.

Launch example:

    ! You are going to build a new rfcmp of BMW_2002Tii !
    Build version (x.xx)? : 1.84
    ...
  1. If everything is ok, rfcmp relase file available in releases directory

  2. Upload the new rfcmp to any share file platform (mediafile, mega,...)

Operation: Push modifications to the forge

It refers to 6a. Push mod files in the schema.

  1. Push the code of the mod with Fork git client: click push button in the Fork interface.