Github

object Github

Utility managing Github access (except the link in WorldScreenCommunityPopup)

Singleton - RateLimit is shared app-wide and has local variables, and is not tested for thread safety. Therefore, additional effort is required should tryGetGithubReposWithTopic ever be called non-sequentially. download and downloadAndExtract should be thread-safe as they are self-contained. They do not join in the RateLimit handling because Github doc suggests each API has a separate limit (and I found none for cloning via a zip).

Types

RateLimit

object RateLimit

Implements the ability wo work with GitHub's rate limit, recognize blocks from previous attempts, wait and retry.

Repo

class Repo

Part of RepoSearch in Github API response - one repository entry in items

RepoOwner

class RepoOwner

Part of Repo in Github API response

RepoSearch

class RepoSearch

Parsed GitHub repo search response

Functions

download

fun download(url: String, action: (HttpURLConnection) -> Unit = {}): InputStream?

Helper opens am url and accesses its input stream, logging errors to the console

downloadAndExtract

fun downloadAndExtract(gitRepoUrl: String, defaultBranch: String, folderFileHandle: FileHandle): FileHandle?

Download a mod and extract, deleting any pre-existing version.

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

renameOrMove

private fun FileHandle.renameOrMove(dest: FileHandle)

toString

open fun toString(): String

tryGetGithubReposWithTopic

fun tryGetGithubReposWithTopic(amountPerPage: Int, page: Int): Github.RepoSearch?

Query GitHub for repositories marked "unciv-mod"

Sources

jvm source