## Table of contents
npm install @projectsophon/procgen- grayColors
- mockCommon
- mockEpic
- mockLegendary
- mockRare
- artifactName
- artifactRandom
- artifactRandomInt
- getBiomeRgbStr
- getHatSizeName
- getOwnerColor
- getOwnerColorVec
- getPlanetBlurb
- getPlanetBlurb2
- getPlanetClass
- getPlanetCosmetic
- getPlanetName
- getPlanetNameHash
- getPlanetTagline
- getPlanetTitle
- getPlayerColor
- getPlayerColorVec
- getRuinsInfo
- hashToHue
- hatTypeFromHash
- hslStr
- hslToRgb
- mockArtifact
- mockArtifactWithRarity
- planetPerlin
- planetRandom
- planetRandomInt
- rgbStr
- titleCase
Ƭ PixelCoords: Object
#### Type declaration
| Name | Type |
| :------ | :------ |
| x | number |
| y | number |
___
Ƭ QuoteData: Object
#### Type declaration
| Name | Type |
| :------ | :------ |
| author | string |
| quote | string |
• Const grayColors: PlanetCosmeticInfo
___
• Const mockCommon: Artifact
___
• Const mockEpic: Artifact
___
• Const mockLegendary: Artifact
___
• Const mockRare: Artifact
▸ artifactName(artifact): string
#### Parameters
| Name | Type |
| :------ | :------ |
| artifact | undefined \| Artifact |
#### Returns
string
___
▸ artifactRandom(loc): () => number
#### Parameters
| Name | Type |
| :------ | :------ |
| loc | ArtifactId |
#### Returns
fn
▸ (): number
##### Returns
number
___
▸ artifactRandomInt(loc): () => number
#### Parameters
| Name | Type |
| :------ | :------ |
| loc | ArtifactId |
#### Returns
fn
▸ (): number
##### Returns
number
___
▸ getBiomeRgbStr(biome): string
#### Parameters
| Name | Type |
| :------ | :------ |
| biome | Biome |
#### Returns
string
___
▸ getHatSizeName(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | Planet |
#### Returns
string
___
▸ getOwnerColor(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | Planet |
#### Returns
string
___
▸ getOwnerColorVec(planet): RGBAVec
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | Planet |
#### Returns
RGBAVec
___
▸ getPlanetBlurb(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |
#### Returns
string
___
▸ getPlanetBlurb2(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |
#### Returns
string
___
▸ getPlanetClass(planet): UpgradeBranchName
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | Planet |
#### Returns
UpgradeBranchName
___
▸ getPlanetCosmetic(planet): PlanetCosmeticInfo
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |
#### Returns
PlanetCosmeticInfo
___
▸ getPlanetName(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |
#### Returns
string
___
▸ getPlanetNameHash(locId): string
#### Parameters
| Name | Type |
| :------ | :------ |
| locId | LocationId |
#### Returns
string
___
▸ getPlanetTagline(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |
#### Returns
string
___
▸ getPlanetTitle(planet): string
#### Parameters
| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |
#### Returns
string
___
▸ getPlayerColor(player): string
#### Parameters
| Name | Type |
| :------ | :------ |
| player | EthAddress |
#### Returns
string
___
▸ getPlayerColorVec(player): RGBAVec
#### Parameters
| Name | Type |
| :------ | :------ |
| player | EthAddress |
#### Returns
RGBAVec
___
▸ getRuinsInfo(loc): RuinsInfo
#### Parameters
| Name | Type |
| :------ | :------ |
| loc | LocationId |
#### Returns
RuinsInfo
___
▸ hashToHue(hash): number
#### Parameters
| Name | Type |
| :------ | :------ |
| hash | string |
#### Returns
number
___
▸ hatTypeFromHash(hash): HatType
#### Parameters
| Name | Type |
| :------ | :------ |
| hash | LocationId |
#### Returns
HatType
___
▸ hslStr(h, s, l): string
#### Parameters
| Name | Type |
| :------ | :------ |
| h | number |
| s | number |
| l | number |
#### Returns
string
___
▸ hslToRgb(__namedParameters): RGBVec
#### Parameters
| Name | Type |
| :------ | :------ |
| __namedParameters | HSLVec |
#### Returns
RGBVec
___
▸ mockArtifact(rarity, artifactType?, planetBiome?): Artifact
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| rarity | ArtifactRarity | undefined |
| artifactType | ArtifactType | ArtifactType.Spaceship |
| planetBiome | Biome | Biome.WASTELAND |
#### Returns
Artifact
___
▸ mockArtifactWithRarity(rarity, artifactType?, planetBiome?): Artifact
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| rarity | ArtifactRarity | undefined |
| artifactType | ArtifactType | ArtifactType.Spaceship |
| planetBiome | Biome | Biome.WASTELAND |
#### Returns
Artifact
___
▸ planetPerlin(loc): (coords: PixelCoords) => number
#### Parameters
| Name | Type |
| :------ | :------ |
| loc | LocationId |
#### Returns
fn
▸ (coords): number
##### Parameters
| Name | Type |
| :------ | :------ |
| coords | PixelCoords |
##### Returns
number
___
▸ planetRandom(loc): () => number
#### Parameters
| Name | Type |
| :------ | :------ |
| loc | LocationId |
#### Returns
fn
▸ (): number
##### Returns
number
___
▸ planetRandomInt(loc): () => number
#### Parameters
| Name | Type |
| :------ | :------ |
| loc | LocationId |
#### Returns
fn
▸ (): number
##### Returns
number
___
▸ rgbStr(rgb): string
#### Parameters
| Name | Type |
| :------ | :------ |
| rgb | RGBVec |
#### Returns
string
___
▸ titleCase(title): string
#### Parameters
| Name | Type |
| :------ | :------ |
| title | string |
#### Returns
string