How to Create the //Lyra/Main Stream

The //Lyra/Main stream is a brand new, empty LyraStarterGame project.

Procedure Overview

You must have successfully set up the //Lyra Depot.

• Create Stream: //Lyra/Main
• Create Workspace
  • Copy New LyraStarterGame Project Contents
  • Add .p4ignore (see Example .p4ignore)
  • Add all non-ignored Content to P4

Summary of Result

• P4 Stream //Lyra/Main will contain a blank LyraStarterGame project
• P4 Workspace Lyra_Main_$(P4USER) will be mapped to //Lyra/Main
  • Stored locally in D:/Dev/Lyra_Main

After Setup: Derive new //Lyra/Xist stream from //Lyra/Main

Create Stream: //Lyra/Main

Set up Powershell variables & environment

$StreamName = "Main"  # Or "Epic" or whatever

$WorkspaceName = "Lyra_$StreamName"

# Set environment variable: P4 Username
$env:P4USER = $env:UserName;  # Change if your P4USER != your PowerShell UserName

# Set environment variable: P4 Workspace Name (P4CLIENT)
#   Each P4USER gets their own workspace on the server
$env:P4CLIENT = "${WorkspaceName}_${env:P4USER}"  # P4 server uses _$P4USER suffix

# Location where you want to store your local Workspace content
$WorkspaceDir = "D:/Dev/$WorkspaceName"

Create Stream //Lyra/$StreamName

# Create $StreamName Stream
p4 stream -t mainline //Lyra/$StreamName

Create Workspace: Lyra_Main_$(P4USER)

Must be in $WorkspaceDir current directory when running p4 workspace.

# make dir $WorkspaceDir if needed
if (!(Test-Path $WorkspaceDir)) {mkdir $WorkspaceDir}

# create workspace ($env:P4CLIENT) for Main stream
cd $WorkspaceDir  # set current directory = $WorkspaceDir for `p4 workspace`
p4 workspace -S //Lyra/$StreamName

Copy LyraStarterGame Project Contents

# Example: Recursive Copy D:/Dev/LyraStarterGame into Workspace dir
cp -Recurse D:/Dev/LyraStarterGame/* $WorkspaceDir

From where you copy your Lyra project source is up to you. Copy it from wherever it is into the $WorkspaceDir.

You may or may not want to try clearing the read-only attributes of the files you are importing. I was having some permissions issues, so I ran this, but it may not have been necessary.

# UNSET read-only flags on all files we copied
# (P4 will mark them read only if needed when we add the files to P4, based on your typemap)
Get-ChildItem -Path $WorkspaceDir -Recurse | %{ if($_.IsReadOnly) {$_.IsReadOnly = $false} }

Add initial .p4ignore so we don’t import anything we don’t want to import

See Example .p4ignore file. You MUST provide a reasonable .p4ignore.

cd $WorkspaceDir

p4 add .p4ignore
p4 submit -d "Initial .p4ignore"

Recursively add all non-ignored files

The -f flag causes files with special characters in their filenames (@, #, etc.) to be added as well.

cd $WorkspaceDir

p4 add -f ...
p4 submit -d "Initial Import"

Congratulations! You have Imported Lyra

You now have a fully initialized //Lyra/Main stream.

• How to: Create the //Lyra/Xist Stream
  • Customize //Lyra/Main into my own reusable //Lyra/Xist

You may or may not want to start hacking away at Lyra. Sometimes that is a good idea. Other times it is not.

To determine what makes sense for you, see Extending Lyra: Development Considerations