Skip to content

kddressel/sailingwiththegods

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sailingwiththegods

License: LGPL v3 Codacy Badge CI

This game is designed to:

  • maximize immersion in the realities of sailing the ancient sea, closing the gap between our modern perspectives of sea travel and ancient realities
  • generate data recorded from players’ behavioral patterns when making choices about how to move about the maritime networks
  • integrate ancient voices from history and mythology with geospatial realities of economic resources, political trends and potential for gathering up to date knowledge

Visit the website for more information!

Setup

This Build uses Unity 2019.4.9f1

unityhub://2019.4.9f1/50fe8a171dd9

Pasting that version link into a browser will auto-launch the installer in Unity Hub, which we recommend.

While the main game code is open source, the game depends on a private repo for assets purchased from the Unity Asset Store. This should go in the Assets/_Proprietary folder. Access to the proprietary repo is limited, but if it is missing the project will populate with open source fallback assets upon loading for the first time in Unity.

Setup Using SourceTree (recommended)

  • Check if you have / need access to the proprietary repo, and create a Github account if you have not
    • Send your Github username to Kevin for access
  • Download and Install SourceTree
    • If asked, say you want embedded git, and you don't want mercurial
    • When asked if you want Bitbucket Server or Bitbucket, click "Skip"
    • So no when asked about loading an SSH key
  • Add Github Account to SourceTree
    • Tools -> Options -> Authentication -> Add
    • Select Github for Hosting Service, leave everything else as it is (HTTPS, OAuth)
    • Click Refresh OAuth Token
    • Authenticate Github in the browser
  • Clone the Repo
    • Make your own fork of the repository on the GitHub website
    • Click the Clone button on your fork
    • Copy paste the fork's HTTPS url into the URL field on the Clone screen
    • Turn on recurse submodules and choose "develop" as the branch name in advanced
    • Choose manager-core on the popup that appear, and choose "Always use this"
    • If you get errors cloning the submodule, try Adding the partially cloned local repo it's made, then delete the .git folder in _Proprietary then go to Repository -> Respository Settings and double click your remote, and make sure Remote Account is your Github, not Generic
  • Add the kddressel repo as upstream remote
    • Click Repository -> Repository Settings
    • Click Add
    • Type "upstream" as the remote name, and paste https://github.com/kddressel/sailingwiththegods.git in as the URL, change to your github account for remote account and click OK
    • Fetch -> And make sure you fetch all remotes (this is the default setting)
    • If needed, right click upstream/branchname and merge into your fork's branch

Unzip the Navmesh

The Main Scene has a NavMesh that's over 100 MB so we have it committed to git as a ZIP file and the actual NavMesh asset is gitignored. After pulling for the first time, you need to unzip. You should see a "Zipped assets have been updated, extract them?" popup. Choose "Yes (recommended)" to automatically extract the zip file.

If you do not see this popup or need to manually unzip, you can either use the SWTG -> Unzip Assets menu, or you can unzip the file manually:

Assets/_Scenes/Main Scene/NavMesh.zip

Git Setup for Windows

  • Install Git for Windows using default settings
    • Make sure you pick "Git Credential Manager Core"
  • Check if you have / need access to the proprietary repo
  • Use https athentication steps below to clone your fork

Clone the project using https authentication

git clone yourforkurl --branch develop
git remote add upstream https://github.com/kddressel/sailingwiththegods.git

# and if you have access to the proprietary repo...
git submodule update --init
  • After running git submodule update --init, you should get a github login popup
  • Choose "Sign in with your browser"
  • Authorize GitCredentialManager to your github account
  • Wait for a while. The submodule is large and may not appear to be downloading immediately

Most of the team is using https, but if you would like to use SSH authentication, follow this guide.

Documentation

About

A historical sailing game by Emory University

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 76.6%
  • ShaderLab 18.6%
  • GLSL 4.2%
  • Other 0.6%