SASTEP: Difference between revisions

From Step Mods | Change The Game
No edit summary
Line 1: Line 1:
related links:
* Wiki [[SASTEP_CoreMods]] for a list of all used mods.
* Forum: http://forum.step-project.com/showthread.php?tid=4227
* Spreadsheet (most current list): [https://docs.google.com/spreadsheet/ccc?key=0Aidm4QUUrmSZdEIwQWVySkY1U1JKNFBDSFM4VU5qUVE&usp=sharing google docs]
==Semi Automatic STEP Tool==
==Semi Automatic STEP Tool==
===What is this?===
===What is this?===
Using the STEP Guide as base, we try to get an automated installer working. To keep it sustainable we also need to create some developer/pack management tools.
Using the STEP Guide as base, we try to get an automated installer working. To keep it sustainable we also need to create some developer/pack management tools. The tools developed here might be of use for other packages outside STEP.
 
===concept===
Development will be completely bottom up. This means there will be many small tools that elevate automation of STEP incrementally (in very small steps, so to speak ;) ). --[[User:MilesTeg|MilesTeg]] ([[User talk:MilesTeg|talk]]) 11:38, December 6, 2013 (EST)
Goal will be to "connect" to the Mod Organizer tool, where all further modding will be handled.


===SASTEP Core===
===SASTEP Core===
Line 11: Line 20:
*special adjustments for multi-archive mods (coming soon)
*special adjustments for multi-archive mods (coming soon)


Wiki [[SASTEP_CoreMods]] for a list of all used mods.
===Tools===
As this seems to move forward more easily and faster than I expected, I will give a brief introduction in what each tool/script does/will do.
 
Dev: all tools mainly meant for package managers, tool developers and mod creators
 
User: tools that will be accessed/run directly by a mod-user (one that just wants a cool modded Skyrim experience)
 
tools from other developers can be found [http://forum.step-project.com/showthread.php?tid=4196 here]
 
 
====dev: getMeta====
recieves meta information about the mod files from MO. this comes in handy if you want to create a new package / update your meta-infos. This should also ease the maintenance of mod packages.
 
how it works: copy into MO download folder and be sure you only have files for your specific mod bundle
in there (+ the meta-files MO creates). Also test all archives to be sure there is no file damadge (bad downloads etc). The script reads out various information about the mods and lists them in a nice csv file.
 
infos:
* fileID: unique ID for each file
* modID: the nexus identifier nr for the mod
* Version (very error prone)
* File Name: similiar to the name shown in nexus downloads section
* mod name: name of the mod
* checksum code: identifies the file by it's data. necessary for later automation.
====dev: datatreecmp====
This tool connects complex mods (installations) with package maintanence.
 
'''Problem:''' some mods have advanced options, variants etc. STEP gives a good recommendation of what to choose from. But the user still has to do it all by himself.
 
'''Solution:''' It compares the uninstalled mod (the zip or 7z file) with the installed one, used in MO. The result will be saved in a new file, that can later on be used for an "one-click" installer.
 
====user: ini tweak====
a very simple script, that takes an ini file (containing only the STEP recommended tweaks) and applies those settings to the skyrim inis (located in the MO profile).
 
====user/dev: generateCoreBookmarks====
a script that automatically generates a bookmarks.html for import in firefox.
source data: STEP wiki ([http://wiki.step-project.com/Special:Ask/-5B-5BIsCore::true-5D-5D/-3FSourceID%3DNexus-20ID/-3FSection/format%3Dcsv/offset%3D0 this] link, to be specific). It uses [[Special:Ask]] to query the data.
 
I have to admit it's currently not usable for anything beyond STEP Core.
But with some changes, it can be used for other mod packages.
 
requires: mods must have an article in the STEP wiki.


Forum: http://forum.step-project.com/showthread.php?tid=4227
====dev: BCF read====
a code snippet ripped from Wrye Bash that simply reads the .bcf patches and exports them in readable text files.


Spreadsheet (most current list): [https://docs.google.com/spreadsheet/ccc?key=0Aidm4QUUrmSZdEIwQWVySkY1U1JKNFBDSFM4VU5qUVE&usp=sharing google docs]
Why? Better tranparency. Now you know what the patch actually does (and if it needs an update)
(Altough BCF isn't used in my concept of an automated STEP)


===Milestones===
===Milestones===

Revision as of 16:38, December 6, 2013

related links:

Semi Automatic STEP Tool[edit | edit source]

What is this?[edit | edit source]

Using the STEP Guide as base, we try to get an automated installer working. To keep it sustainable we also need to create some developer/pack management tools. The tools developed here might be of use for other packages outside STEP.

concept[edit | edit source]

Development will be completely bottom up. This means there will be many small tools that elevate automation of STEP incrementally (in very small steps, so to speak ;) ). --MilesTeg (talk) 11:38, December 6, 2013 (EST) Goal will be to "connect" to the Mod Organizer tool, where all further modding will be handled.

SASTEP Core[edit | edit source]

We will create a barebone install with all mods, marked as core (green) in the guide. To further narrow down the specification we use the following rules (not final in any way!!):

  • word by word step guide installation +
  • baseline graphics downloads
  • requires all DLCs
  • special adjustments for multi-archive mods (coming soon)

Tools[edit | edit source]

As this seems to move forward more easily and faster than I expected, I will give a brief introduction in what each tool/script does/will do.

Dev: all tools mainly meant for package managers, tool developers and mod creators

User: tools that will be accessed/run directly by a mod-user (one that just wants a cool modded Skyrim experience)

tools from other developers can be found here


dev: getMeta[edit | edit source]

recieves meta information about the mod files from MO. this comes in handy if you want to create a new package / update your meta-infos. This should also ease the maintenance of mod packages.

how it works: copy into MO download folder and be sure you only have files for your specific mod bundle in there (+ the meta-files MO creates). Also test all archives to be sure there is no file damadge (bad downloads etc). The script reads out various information about the mods and lists them in a nice csv file.

infos:

  • fileID: unique ID for each file
  • modID: the nexus identifier nr for the mod
  • Version (very error prone)
  • File Name: similiar to the name shown in nexus downloads section
  • mod name: name of the mod
  • checksum code: identifies the file by it's data. necessary for later automation.

dev: datatreecmp[edit | edit source]

This tool connects complex mods (installations) with package maintanence.

Problem: some mods have advanced options, variants etc. STEP gives a good recommendation of what to choose from. But the user still has to do it all by himself.

Solution: It compares the uninstalled mod (the zip or 7z file) with the installed one, used in MO. The result will be saved in a new file, that can later on be used for an "one-click" installer.

user: ini tweak[edit | edit source]

a very simple script, that takes an ini file (containing only the STEP recommended tweaks) and applies those settings to the skyrim inis (located in the MO profile).

user/dev: generateCoreBookmarks[edit | edit source]

a script that automatically generates a bookmarks.html for import in firefox. source data: STEP wiki (this link, to be specific). It uses Special:Ask to query the data.

I have to admit it's currently not usable for anything beyond STEP Core. But with some changes, it can be used for other mod packages.

requires: mods must have an article in the STEP wiki.

dev: BCF read[edit | edit source]

a code snippet ripped from Wrye Bash that simply reads the .bcf patches and exports them in readable text files.

Why? Better tranparency. Now you know what the patch actually does (and if it needs an update) (Altough BCF isn't used in my concept of an automated STEP)

Milestones[edit | edit source]

Milestones for the proof-of-concept-tools that will set the base for a complete installation program/ MO plugin etc. Once we are done with betatesting there should be a reset to an alpha that will incorporate all (probably) separated tools into a unified codebase.

  • Alpha state:
  1. Define and assemble a list of all archives (filename and checksum) that'll be used for the STEP core installation (currently on hold till it gets clear if there isn't an automnated way of doing it)
  2. (parallel to #1) get a working tool that returns the changed filestructure as config file for MG's ASI. (current WIP)
  3. (needs #2)
    1. install all mods according to the STEP core guide (+ our definition of STEP core)
    2. run the tool from #2. Adjust the tool if necessary
    3. Milestone is reached once all config files for STEP core are completed.
  4. create a tool that installs STEP core in separate folders.
    1. A simple batch file (for now) will just copy them all together for testing / or we create a switch in the ASI tool
  5. Bundle it all in one toolkit / one downloadable zip file.
    1. documentation
    2. bugfixing, catch errors/exceptions
  • Beta state:
  1. let the community give feedback and suggestions.

later/not time critical, yet:

  • a: define how data should be imported into the wiki (filelists for each mod? file archive based?)
    • 1: import data into the STEP wiki; make it editable for mod authors
    • 2: create a query that returns data ready for our tool
  • b: MO metafile-write support (have to check if I already got this working)
    • 1: a function that will edit the metas after the installation is complete
  • c: get a version control up and running

Semi Automated STEP Core Mod List[edit | edit source]

follow the main STEP guide till STEP 2.D STEP:Guide

SASTEP CoreMods