Tutorial: Adding Music to Your MOD Civilization

[NerdByFate]

A few notes for anyone attempting to follow this guide:
1. See Eras.artdef in the base game's files for all of the switches you can use. Not every era has its own switch in the game. Classical uses Ancient's switch, Renaissance uses Medieval's switch, Modern uses Industrial's switch (weirdly). and both Atomic and Informational use Modern's switch (meaning that whatever you assign to modern won't actually play until Atomic). This means you can't assign a playlist to every era, some will simply carry over to the next era(s).
2. Your playlists will not loop throughout their respective eras by default. To accomplish this, visit this link.
3. If you have already linked a Civilizations.artdef to use base game music and you want to switch over to this, you MUST remove this link as it overrides the custom SoundBank. If you don't, the music you selected in Civilizations.artdef will play, not your music.

 

[MadManCam]

As of right now, it seems Wwise version 2015.1.9 is no longer easily available on the internet. The direct link in OP is currently dead ("access denied"). I also searched for a while on the site and in the version installer, where it seems the oldest version available is 2016.2.6.6153.

Anyone got a copy of the correct software version installer saved? If so, it would be amazing to have a stable link.

Otherwise, any tips besides contacting AudioKinetic (which I've already done and suggest you do as well)? Has Civ 6 audio modding become endangered?


EDIT: I've also submitted a Wwise project to AudioKinetic as described in below post, pending approval.

EDIT 2: The non-commercial license was approved the following business day! However, it didn't provide any links to the specific software I had requested. I posted in the community forum on the site. About a week later, it was answered anonymously with this link, and I think you have to log in to access it.

https://www.audiokinetic.com/downloads/previous/

I'm pretty sure that page and version wasn't available before, but I can't be certain. Anyways, it seems to be available for now.

 

[raen]

Hi, the setup will not work anyway, just tried, seems like they removed all older versions or changed place we don´t know of... Unless somebody has a full install.

Anyway I posted a contact in the site company of wwise, lets see if they answer.

EDITED: Answer arrived! But they send the same link of older versions that is not working or showing older versions at all.... in the site there´s not even information about release notes 2015 versions. So I reiterated the question with a print, lets see now.

EDITED2: If you choose non commercial project with "I need more than 200 media assets" choice you can specify the version, but you sign an agreement and it is pending approval right now. Lets see if I have the application available that way.

 

[raen]

In the last contact they said that that versions (2015 and previous) were really removed from site but they will be working one some new policies for managing access like this for modding, and it should make it easier for everyone.

That version 2015 still available via company project thought, that works by request and approval.

Anyway, a question from them is why do we need this specific version? I am not expert at this at all, so I ask you people why do we need this version? because the options? the output? whatever reason?

Thanks!

 

[raen]

Finally added music to my mod, many thanks for this tutorial @FurionHuang and also for @NerdByFate tips.

Still testing, for the moment, only having problem on resume when entering my diplo screen (same music starts on that screen but when in game again no music playing)

 

[raen]

I solved the above problem.

Problem: For Leader music events, if we add the same DS_MUSIC, the game starts with music correctly but when you access your Diplo Screen the game will start the same music loop and when in game again does not resume, from there on, simply no music in game, only in diplo screen.

The solution is to link Leader music events to another playlist or a music directly (I did this, dont know about diplo screens music that well but I think it plays only one song right?). This way plays in game DS_MUSIC for the various eras, and when entering diplo screen plays a new song (you chosen above), and when back in game again the music of ERAS is resumed.

Spoiler Modifying this tutorial for Leader Events :

For civ events, like in tutorial, you add DS_Music, and that way is playing along the Eras.

 

[raen]

so i think i did everything the way it is described here, including adding the scripts from Gedemon and FurionHuang that fix stuff, but there are still situations in which the music breaks or multiple tracks play at the same time
2 different situations:

-music works liek it should, i go to my leader screen (leader icon in the top right corner) music start from the beginning (i assume the regular one gets paused and the Leader_Music starts), same happens if i go to diplomacy screens of other civs
but when i return to the map the music does not resume (at least not always, sometimes it still works)

-when restarting the game the music from the first game keeps playing, so after settling the first city in the restarted game the track is playing 2 times

any idea what i could have done wrong or how to fix this?
one thing in this tutorial i dont get is the "costum cue" thing, how do i add a costum cue, what do i have to do etc.... (only using exit cue so far)

To solve the first point you have to add a different object then DS_Music for Leader events, for more details see my last post above this.

The second point i think is solved by Gedemon and FurionHuang scripts, you can see it applied in NerdByFate´s Rise Of Datlof InGame (mod folder) Lua Scripts.

 

[raen]

A few notes for anyone attempting to follow this guide:
1. See Eras.artdef in the base game's files for all of the switches you can use. Not every era has its own switch in the game. Classical uses Ancient's switch, Renaissance uses Medieval's switch, Modern uses Industrial's switch (weirdly). and both Atomic and Informational use Modern's switch (meaning that whatever you assign to modern won't actually play until Atomic). This means you can't assign a playlist to every era, some will simply carry over to the next era(s).
2. Your playlists will not loop throughout their respective eras by default. To accomplish this, visit this link.
3. If you have already linked a Civilizations.artdef to use base game music and you want to switch over to this, you MUST remove this link as it overrides the custom SoundBank. If you don't, the music you selected in Civilizations.artdef will play, not your music.

Your tips make custom music more possible!

1- I am working in a Lua solution to play Each era songs, hopefully will work.
2- Its about the infinite, but we can play along with that playlist. I have for instance infinite, run 1 music one time, and then infinite again, now with my role of songs I want to play in loop. Seems like firaxis adds some null time, so that music is not so continuous.
3- This tip is awesome, along solving custom civ music, solves all other civs music too, if not all will play our custom audio. In detail this implies to remove Civilizations.artdef link from mod.art.xml (or Dep).

 

[raen]

How to add Peace and War music

Because of a bug I stumbled how to make Peace and War music. With all working, when entering war with another CIV (and not City State) the music stopped, so instead of trying to solve the bug (which I tried a trillion of times), why not run my music of war. The peace music is current custom music of tutorial and we need to make new for war.

So, how do you do it (similar steps to tutorial, complement all with the tutorial):
- Create a new Playlist DS_MUSIC_WAR (the name you want to give).
- Import all the music you want there (don´t forget the stream property)
- Drag your musics, to play infinite, any order you want
- Make two new events, of stop and play your music (example: Stop_raenWARMUSIC and Play_raen_WARMUSIC)
- To those events assign DS_MUSIC_WAR object, created above.
- Generate banks like tutorial.

Now with music deployed we need to put it to work in game. You achieve this by a little Lua Script:

Spoiler Code Sample :

local isWar = 0
local isWarMusicStarted = 0
local isPeaceMusicStarted = 1


function OnUnitsMovePlaySound(PlayerID, UnitID, x, y, locallyVisible, stateChange)
 
  if (IsPortugueseLeader (PlayerID) == true) then
 
    if (isWar > 0 and isWarMusicStarted == 0 and isPeaceMusicStarted == 1) then
      print("  WARRRRRR MUSIC" );
      UI.PlaySound("Stop_Music_PORTUGAL");
      UI.PlaySound("Play_Battle_PORTUGAL");
      print(" WARRRRRR MUSIC ADDEDDDDDDDDDDD");
      isWarMusicStarted = 1;
      isPeaceMusicStarted = 0;
    end
    if (isWar > 0 and isWarMusicStarted == 0 and isPeaceMusicStarted == 0) then
      print("  WARRRRRR MUSIC Start" );
      UI.PlaySound("Play_Battle_PORTUGAL");
      print(" WARRRRRR MUSIC start ADDEDDDDDDDDDDD");
      isWarMusicStarted = 1;
    end
    if (isWar == 0 and isPeaceMusicStarted == 0 and isWarMusicStarted ==1) then
      print("  PEACEEE PLAY" );
      UI.PlaySound("Stop_Battle_PORTUGAL")
      UI.PlaySound("Play_Music_PORTUGAL");
      print("  PEACEEE PLAY MUSIC ADDEDDDDDDDDDDD");
      isPeaceMusicStarted = 1;
      isWarMusicStarted = 0;
    end
  end
end

function DeclaredPeacePlaySound(actingPlayer, reactingPlayer)
  if(IsPortugueseLeader (actingPlayer) == true or IsPortugueseLeader (reactingPlayer) == true) then
    print("  PEACECCCCECEE" );
    isWar = isWar -1;
    print("  Is WAR " .. isWar);
  end
end

function DeclaredWarPlaySound(actingPlayer, reactingPlayer)
  if(IsPortugueseLeader (actingPlayer) == true or IsPortugueseLeader (reactingPlayer) == true) then
    print("  WARRRRRR" );
    isWar = isWar +1;
    print("  Is WAR " .. isWar);
  end
end
----------Events----------
--FOR CUSTOM MUSIC!!!!
Events.DiplomacyDeclareWar.Add( DeclaredWarPlaySound );
Events.DiplomacyMakePeace.Add( DeclaredPeacePlaySound );
Events.UnitMoved.Add( OnUnitsMovePlaySound );

 

[raen]

How to add music to each Era

The music is Eras music is organized in pairs, but if you want to have different music for each Era, I know a way to achieve this.

I don´t change any of the result of this tutorial, that I believe is needed to all work, I just add more stuff (like I added war playlist).
- First create all the playlists, 8 instead of 4.
- In Events, add play and stop of each era
- Add events to sound bank and generate.

Now in game nothing works unless with some Lua
- You get current Era with player:GetEra()+1 and check if you have right music playing
- Its all about stop main ERAS music (and also the current custom ERA playing) and start you specific Era music.

For further details, you may want to see my Portugal mod In game Lua Script.

 

[HaoJun0823]

How to add music to each Era

The music is Eras music is organized in pairs, but if you want to have different music for each Era, I know a way to achieve this.

I don´t change any of the result of this tutorial, that I believe is needed to all work, I just add more stuff (like I added war playlist).
- First create all the playlists, 8 instead of 4.
- In Events, add play and stop of each era
- Add events to sound bank and generate.

Now in game nothing works unless with some Lua
- You get current Era with player:GetEra()+1 and check if you have right music playing
- Its all about stop main ERAS music (and also the current custom ERA playing) and start you specific Era music.

For further details, you may want to see my Portugal mod In game Lua Script.

Hi, raen.
Thanks for your research, I tried your way for the diplomatic interface and it went well.
But when I use other civilizations to access the civilization of custom music, I trigger any function (such as trading, declare friendly), which will cause the music to stop and then replay (only for the diplomatic interface).
Have you found this problem? I have deleted these two events now(Play_Leader_Music&Stop_Leader_Music), which also makes it impossible for me to hear any music on the diplomatic interface (the original era music).
I tried your mod and it has this problem. Is there any good way for anyone to have this piece of content?

Tip: LAN mode, you choose an official civilization, add your Mod civilization, set them as a team, enter the game, open the diplomatic interface of your allies, just press any button (such as trading, declare friendly), this problem will happen.

 

[raen]

So you are talking about multiplayer problem? Or it happens in single player too?

 

[HaoJun0823]

So you are talking about multiplayer problem? Or it happens in single player too?

Both single and multiplayer mode will happen, I am sorry that my English is not very good.
I just want to remind you how to find this problem faster.
Have you tested it?

 

[raen]

Both single and multiplayer mode will happen, I am sorry that my English is not very good.
I just want to remind you how to find this problem faster.
Have you tested it?

I did not have the chance to test it yet, but still trying to identify the problem. Are you saying that you start a game with other CIV, imagine China, and when you click "CIV with custom music" ok, but then stops clicking other places? Or are you playing with "CIV with custom music"

Anyway I know a place where music stops, when you navigate to diplomatic screen of your leader for suppose, and then navigate to other leaders in left side of screen, music stops, its something about UI I didn't solve yet.

 

[HaoJun0823]

I did not have the chance to test it yet, but still trying to identify the problem. Are you saying that you start a game with other CIV, imagine China, and when you click "CIV with custom music" ok, but then stops clicking other places? Or are you playing with "CIV with custom music"

Anyway I know a place where music stops, when you navigate to diplomatic screen of your leader for suppose, and then navigate to other leaders in left side of screen, music stops, its something about UI I didn't solve yet.

For example, you choose China (official civilization), the other is your Mod civilization (with custom music), 1vs1, when you meet him, you open his diplomatic interface, click the button multiple times (announced Friendly or otherwise), music will stop and play from the beginning (whenever you press the button).

I didn't try this problem with clicking on the sidebar.

 

[raen]

Ok, got it now. Will try it out when i can and let you know. Thanks for the feedback.

 

[HaoJun0823]

Ok, got it now. Will try it out when i can and let you know. Thanks for the feedback.

Anyway, thank you for your contribution!

 

[raen]

I tested it, and I caught another previous problem, diplo music from Portugal playing AI never stops, and overlaps current human civ. I have a kind solution to this problem, that is stopping Portugal leader Music when some unit moves (I have to find a better event...)

Besides that, I see that music of human civ stops like you say, but then Portuguese music start somewhere later! I don´t control that, have to find right event to stop Portugal music and start the current civ music (and still have to find the Start trigger for all civs music!)

Thanks for the feedback.

 

[HaoJun0823]

I tested it, and I caught another previous problem, diplo music from Portugal playing AI never stops, and overlaps current human civ. I have a kind solution to this problem, that is stopping Portugal leader Music when some unit moves (I have to find a better event...)

Besides that, I see that music of human civ stops like you say, but then Portuguese music start somewhere later! I don´t control that, have to find right event to stop Portugal music and start the current civ music (and still have to find the Start trigger for all civs music!)

Thanks for the feedback.

Thank you for your report.
Although very frustrating, we have near-perfect Custom Era Music.
During this time, I analyzed the contents of the DLC, but did not find anything special, I will keep up until anyone or I found a solution.
Give my thanks to everyone for their efforts!

 

[FurionHuang]

@sukritact Hey man seems like you had some help from Ian Schmidt. Would you mind share what the trick was?