# memorytest
> **BUILD STATUS**
Latest version **1.0.11** (published 2017-12-10) · 0 weekly downloads
## Install
```sh
npm install memorytest
pnpm add memorytest
yarn add memorytest
bun add memorytest
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.11 |
| Published | 2017-12-10 |
| First published | 2017-12-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | maaa16 |
## Links
- npm: https://www.npmjs.com/package/memorytest
- npm.io page: https://npm.io/package/memorytest
## Dependencies (1)
- [ws](https://npm.io/package/ws.md) ^3.3.2
## Recent versions
- 1.0.11 (latest) — 2017-12-10
- 1.0.10 — 2017-12-09
- 1.0.9 — 2017-12-09
- 1.0.8 — 2017-12-09
- 1.0.7 — 2017-12-09
- 1.0.6 — 2017-12-09
- 1.0.5 — 2017-12-09
- 1.0.4 — 2017-12-09
- 1.0.3 — 2017-12-09
- 1.0.2 — 2017-12-09
- 1.0.1 — 2017-12-09
- 1.0.0 — 2017-12-09
## README
**BUILD STATUS**
*Travis*: [](https://travis-ci.org/bredsjomagnus/memorytest), *Scrutinizer*: [](https://scrutinizer-ci.com/g/bredsjomagnus/memorytest/build-status/master)
**CODE COVERAGE**
*Scrutinizer*: [](https://scrutinizer-ci.com/g/bredsjomagnus/memorytest/?branch=master), *Coveralls*: [](https://coveralls.io/github/bredsjomagnus/memorytest?branch=master), *Codecov*: [](https://codecov.io/gh/bredsjomagnus/memorytest)
**CODE QUALITY**
*Scrutinizer*: [](https://scrutinizer-ci.com/g/bredsjomagnus/memorytest/?branch=master), *Codeclimate*: [](https://codeclimate.com/github/bredsjomagnus/memorytest/maintainability), *Codeacy*: [](https://www.codacy.com/app/bredsjomagnus/memorytest?utm_source=github.com&utm_medium=referral&utm_content=bredsjomagnus/memorytest&utm_campaign=Badge_Grade)
# Memory Game
## A module for educational purposes
This is a test module for **educational purposes** (PA1442 H17 Lp2 Webbaserade ramverk 2, [BTH](https://www.bth.se/)).
### Installation
`npm install memorytest`
Detta är blott och enbart klasserna för att sätta upp och spela memoryspelet på serversidan.
Den är beroende av modulen `ws`.
---
#### Kod och bilder som måste läggas till
**Serversidan**
lib/Server/memoryserver.js eller [memoryserver.js](https://github.com/bredsjomagnus/memorytest/blob/master/lib/Server/memoryserver.js)
*Läggs in i bin/www eller motsvarande.*
**Klienten**
lib/Client/memoryclient.js eller [memoryclient.js](https://github.com/bredsjomagnus/memorytest/blob/master/lib/Client/memoryclient.js)
*Glöm inte sätta ws host:port i koden i klienten.*
```
connect.addEventListener("click", function() {
websocket = new WebSocket('ws://host:port/');
```
**Bilder**
lib/Images/Memorycards eller [memorycards](https://github.com/bredsjomagnus/memorytest/tree/master/lib/Images/Memorycards)
*Att lägga under public/images/memorycards/*
*Nuvarnde bildnamn är "alpaca.png", "giraff.png", "monkeys.png", "panda.png", "puppy.png", "ram.png", "wolf.png", "squirrel.png", "fox.png", "bear.png".*
*Vill man ha andra bilder ändras detta i lib/Memory/Memorycard.js och att det finns korresponderande bilder i public/images/memorycards/*
**Style**
lib/Style/memory.less eller [memory.less](https://github.com/bredsjomagnus/memorytest/blob/master/lib/Style/memory.less)
*Att lägga under public/stylesheet/*
**HTML**
lib/Pug/memory.pug eller [memory.pug](https://github.com/bredsjomagnus/memorytest/blob/master/lib/Pug/memory.pug)
*Bara ett skelett som bygger på bootstrap. Måste själv extend layout och lägga till scripts så som memoryclient.js.*
---
### Beskrivning av klasserna
#### Gameboard
Spelbrädet som skickas till spelarna för uppdatering av webbläsaren.
Spelbrädet kan idagsläget enbart skapas med storleken Gameboard(4, 5)
params:
- width - antalet rutor horisontellt
- height - antalet rutor vertikalt
- numOfCards
- position
- cardvalue
- activeplayer
- gotpair
- pairpositions
- pairvalues
- paircolors
Metoder:
- getWidth() returns int width
- getHeight() return int height
- setWidth(int width)
- setHeight(int height)
- setGotPair(gotpair)
- addPosition(position)
- addCardValue(cardvalue)
- addPairPositions(pairposition)
- addPairValues(cardvalue)
- addPairColors(colorclass)
- resetCards() flips all cards
- setActivePlayer(string player)
#### Gamebrain
Spelhjärnan som håller koll på regler, vilka spelarna är och vad som bör hända härnäst beroende på vad spelarna gör.
params:
- colors - *string* möjliga färger på spelarna. Begränsar antalet spelare.
- "blackplayer",
- "redplayer",
- "blueplayer",
- "greenplayer",
- "pinkplayer",
- "orangeplayer",
- "yellowplayer",
- "limegreenplayer",
- "purpleplayer"
- usedcolors - *string* namnen på de färger som används
- players - *string* spelomgångens spelares namn
- playersscore
- paircheck
- playerinturnmarker - *int* markör för spelets turgång
- playerinturn *string* namnet på spelaren som är på tur
- numberofplayermoves - *int* antalet drag en spelare har gjort under sin tur
- cardvalues - vända kort
Metoder:
- addPlayer(*string* player, *string* color)
- makeMove()
- setCardValue(*string* player, *string* colorclass, *string* cardvalue) - metod för att avgöra om en spelares drag är slut eller inte efter att ha lyft ett kort.
- setActivePlayer(firstround = false) return *string* aktiv spelares namn. Metoden anropas med *true* för första spelrundan och då slumpas en spelare fram som får börja.
- dropPlayer(*string* player) - tar bort spelare från spelomgången.
- setPlayerColor(*string* player) - return *string* färg på spelaren. Sätter unik färg på *player*.
- uniquifyname(*string* incomingnickname) - return *string* unikt spelarnamn. Om någon redan har önskat nickname sätt en siffra bakom nya nicknamet med början på 2. Exemplevis doe och doe2.
- getPlayersNicks() - return *array* alla deltagande spelarnas namn
- getPlayersColors() - return *array* alla deltagande spelarnas färger
- gotPair() - return *string* nopair om det inte var ett par. Annars spelarens som lyfte parets färg.
#### Memorycard
Innehåller informationen om korten i spelet. Vad för bild som är på och vilken plats kortet ligger på på spelbärdet.
params:
- cards - *Map* [[*string* position, *string* cardvalue],... ]
- cardvalues - *array* med namnet på bilderna (*string*)
- positions - *array* med positionerna som (*string*)
- numOfCards - *int* antalet kort
Metoder:
- getCardValue(position) - return *string* kortvärde (bildnamn) på viss given position
- getPairPositions(pairvalue) - return *array* positionerna för kort med värdet *pairvalue*
- isPair(cardone, cardtwo) - return *boolean* true om korten är ett par. False annars.
- placeCards(random = true) - placerar korten på brädet. Om man anropar med *false* blandas inte korten innan.
- shuffle() - blandar korten.
- getCardValues() - return *array* med alla kortens värde (bildnamn)
---
_Source: https://npm.io/package/memorytest · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._