Skip to content

Commit 0d48c72

Browse files
Update new version instructions
1 parent 372ca12 commit 0d48c72

3 files changed

+15
-24
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ BuildOutput/
5252
BuildTemp/
5353
Build/
5454
Packages/
55+
Output/
5556

5657
#ignore clang build intermediates
5758
clang-build/

NEW RELEASE INSTRUCTIONS.txt

+12-23
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ If the new release is savegame incompatible:
3333
- For (2), (3a), (3b), and (4a), increment the .civ5proj file's minimum version of the Community Patch (required as a dependency) by 1.
3434
- Increment the version numbers at the beginning of the CvGameCoreDLL_Expansion2/CustomMods.h file by 1.
3535

36-
NOTE: .gitignore is set to ignore the Vox Populi Installer Files/(1) Community Patch (v. #) between n and n+10, inclusive, where n is the current version number. Should the version number rise by more than 10, .gitignore will need updating.
37-
3836

3937

4038
[STEP 4]
@@ -43,6 +41,7 @@ A. Change the displayed version number on the teasers for the following mods:
4341
- (2) Vox Populi
4442
- (3a) VP - EUI Compatibility Files
4543
- (3b) 43 Civs Community Patch
44+
- (4a) Squads for VP
4645

4746
Remember that the version number format is "X.Y.Z"
4847
WHERE X = major version number,
@@ -53,7 +52,7 @@ Z = savegame compatible release
5352
B. Change the current version number on ISSUE_TEMPLATE in the main folder to match the new version number.
5453

5554

56-
C. Change MyAppVersion in CPPSetupData.iss to match the new version number.
55+
C. Change MyAppVersion in VPSetupData.iss to match the new version number.
5756

5857
Tip: Notepad++'s Find in Files feature can be useful for this step, but it will not update ISSUE_TEMPLATE.
5958
Find what: {Old Version Number}
@@ -122,50 +121,40 @@ A. Build the following mods in ModBuddy:
122121
- (2) Vox Populi
123122
- (3a) VP - EUI Compatibility Files
124123
- (3b) 43 Civs Community Patch
125-
- (4a) UI - Promotion Tree for VP
126-
127-
B. Copy the compiled mods from your MODS folder and place them in the Vox Populi Installer Files folder.
124+
- (4a) Squads for VP
128125

129-
C. Remove the version numbers at the end of the mod folder names.
126+
NOTE: The autoinstaller will use the versions from the Build folder in the main directory. ModBuddy will also create a copy in your MODS folder, which you can delete.
130127

131128

132129

133130
[STEP 10]
134-
A. Cut and paste the LUA folder in the (1) Community Patch mod into the "LUA for (1) CP" folder.
135-
136-
137-
B. Cut and paste the LUA folder in the (2) Vox Populi mod into the "LUA for (2) VP" folder.
131+
If you've done everything correctly, you can open the VPSetupData.iss file and hit "Compile". When it finishes, the compiled autoinstaller will be located in the "Output" subfolder.
138132

139133

140134

141135
[STEP 11]
142-
If you've done everything correctly, you can open the CPPSetupData.iss file and hit "Compile". When it finishes, the compiled autoinstaller will be located in the "Output" subfolder.
143-
144-
145-
146-
[STEP 12]
147-
Copy the newly compiled .modinfo files for the following mods from Vox Populi Installer Files to the mods' individual folders in the main folder:
136+
Copy the newly compiled .modinfo files for the following mods from Build to the mods' individual folders in the main folder:
148137
- (1) Community Patch
149138
- (2) Vox Populi
150139
- (3a) VP - EUI Compatibility Files
151140
- (3b) 43 Civs Community Patch
152-
- (4a) UI - Promotion Free for VP
141+
- (4a) Squads for VP
153142

154143

155144

156-
[STEP 13]
145+
[STEP 12]
157146
Create a commit for the new release, and tag it as shown below.
158147
Commit Name: "{Version Number} Release"
159148
Tag Name: "Release-{Version Number}"
160149

161150

162151

163-
[STEP 14]
152+
[STEP 13]
164153
Push the release commit to GitHub.
165154

166155

167156

168-
[STEP 15]
157+
[STEP 14]
169158
A. Go to Releases on GitHub and draft a new release. Upload the compiled autoinstaller and zipped Debug folder to the release binaries.
170159

171160

@@ -195,7 +184,7 @@ F. Publish the release.
195184

196185

197186

198-
[STEP 16]
187+
[STEP 15]
199188
IF NOT SAVEGAME COMPATIBLE: Make a new version thread on CivFanatics, including the changelog.
200189

201190
IF SAVEGAME COMPATIBLE: Edit the existing release thread on CivFanatics. Edit the title, add the changelog to the OP, and also make a new post in the thread (including the changelog) to alert everyone.
@@ -206,5 +195,5 @@ After making the thread, copy and paste the forum thread link next to "**Release
206195

207196

208197

209-
[STEP 17]
198+
[STEP 16]
210199
Announce the new version on Vox Populi's Discord server. If the new release is NOT savegame compatible, ping @everyone in your announcement.

NEW TEST VERSION INSTRUCTIONS.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,13 @@ Vox Populi With EUI
6161
- Build or copy (1) Community Patch. Delete the LUA folder inside it.
6262
- Build or copy (2) Vox Populi. Delete the LUA folder inside it.
6363
- Build or copy (3a) EUI Compatibility Files.
64+
- Build or copy (4a) Squads for VP (optional).
6465
- Copy the VPUI folder in the Vox Populi Installer Files folder and paste it into your Steam DLC folder.
6566
- Copy the UI_bc1 folder in the Vox Populi Installer Files folder and paste it into your Steam DLC folder.
6667
- Copy the VPUI Text/VPUI_tips_en_us.xml file to your Text folder (Documents/My Games/Sid Meier's Civilization 5/Text).
6768

6869
43 Civs
69-
- Also copy (3b) 43 Civs Community Patch.
70+
- Also copy (3b) 43 Civs Community Patch. Make sure it does not contain a compiled .dll file - the 43 Civ DLL should be in the (1) Community Patch folder.
7071

7172
Copying the UI folders and text file is not necessary if you already have them installed and no changes have been made to them since. However, make sure you've followed Step 2 and deleted any folders that shouldn't be there.
7273

0 commit comments

Comments
 (0)