https://github.com/zhenglinlei/tkapi
API bot for tik tak toe game
https://github.com/zhenglinlei/tkapi
bot game javascript tiktaktoe
Last synced: 11 months ago
JSON representation
API bot for tik tak toe game
- Host: GitHub
- URL: https://github.com/zhenglinlei/tkapi
- Owner: ZhengLinLei
- License: apache-2.0
- Created: 2021-06-14T13:54:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-14T16:41:22.000Z (about 5 years ago)
- Last Synced: 2025-03-24T17:05:08.560Z (over 1 year ago)
- Topics: bot, game, javascript, tiktaktoe
- Language: HTML
- Homepage: https://zhenglinlei.github.io/TkAPI/
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
TkAPI Bot - Tik Tak Toe Bot
TkAPI is a library API Bot where you make the the Tik Tak Toe Game easily with this bot
using Typescript/JavaScript and other languages.
This is a bot not an AI
A example website [here](https://zhenglinlei.github.io/TkAPI/tutorial/)
## Index
Learn how to use this library
- [Content](#content)
- [Getting Started](#gettingstarted)
- [Examples](#examples)
- [Extension](#extension)
Before getting started to your tik tak toe game it is necessary to know what includes in this repository.
You can view code examples in `./tutorial` folder, and the source code in `./src` folder. The minified project files are in the `./min` folder where includes two files:
*Main file*
``
./min/tkapi.min.js
``
**Extension file**
_This file is an extension from the main file. If you want to create an easy and fast view, we have the solution for you. For the documentation [here](#extension)_
``
./min/tkapiGui.min.js
``
#### Guide
**Properties**
- [class.options](#class.options)
**Method**
- [class.getResponse(:int)](#class.getResponse)
- [class.getHistory()](#class.getHistory)
- [class.getSimplyUI()](#class.getSimplyUI)
- [class.getWinner()](#class.getWinner)
- [class.reset()](#class.reset)
**Unfortunately we do not have a CDN, but you can clone the repo and use it in local**
### 1. Firstly add the script to your project
```html
```
And if you want to use the auto make default UI view add this script before the main file
```html
```
### 2. Create a varible with the class
_Here we are going to learn how to use only the main class, if you want to read the extension documentation click [here][#extension]_
In your JS file or inner script tag
```javascript
const TKAPI = new TkApi();
```
The object require options, if you do not pass anything the bot use the defaults options.
All this options can be changed in process, with the property of the class `class.options` replacing the class to your variable name.
```javascript
{
symbol: {
// Symbol used for simply UI if you want to personalizate it; Options (x | 0) :Default | Str
bot: "x",
user: "o"
},
botType: "Bot", // Options "Bot" :Default | "Random"
speed: 5 // Options in ms, miliseconds 5 :Default | Int > 0; This is for a synchronous pause when the bot response
}
```
You can change the options with `class.options` property
```javascript
TKAPI.options = {
symbol: {
bot: "-",
user: "*"
},
botType: "Random",
speed: 5
}
```
### 4. Making a request to the bot [ class.getResponse(:int) ]
The `class.getResponse(:num)` is a conection between user and bot, need one parameters and must be a number between 0 to 8, logically the 8 positions avalibales in the tik tak toe table.
After you call this method with the position where the user want to put the token in the table, the bot returns a number, and it is the position of the table where the bot chose.
If you pass a not empty position, the bot returns an error
```javascript
TKAPI.getResponse(4);
```
You can save the the value in a variable and then use it
```javascript
let botNumberPosition = TKAPI.getResponse(4);
console.log(botNumberPosition);
// Output: Int
//
// 2
```
### 5. Get the game history [ class.getHistory() ]
If you want to check the history of the game you can use `class.getHistory()`, and it will return an object
```javascript
let historyGame = TKAPI.getHistory();
console.log(historyGame);
//Output: Object
//
// {
// user: [0, 1],
// bot: [2],
// round: 2
// }
```
### 6. Get a simply status view [ class.getSimplyUI() ]
When you are debugging or you want to view the status, you can call this function to get the interface of the game in the console
```javascript
TKAPI.getSimplyUI();
//Output: Str
//
// ___ ___ ___
// | o | | x |
// ___ ___ ___
// | | | |
// ___ ___ ___
// | | | |
// ___ ___ ___
//
// Round: 1
```
### 7. Get the winner [ class.getWinner() ]
When the bot stopped running, means that finish all the process and you can call `class.getWinner()` and will return 4 values `false | 'bot' | 'user' | 'draw'`
- `false`: When nobody won or the round is in process or not finished
- `'bot'`: When the bot won the game
- `'user'`: When the user won the game
- `'draw'`: When the process finished and nobody won the game
```javascript
console.log(TKAPI.getWinner());
//Output: Str | Boolean
//
// false
```
### 8. Reset all [ class.reset() ]
For reset all
HTML
```html
```
JavaScript
```javascript
const TKAPI = new TkApi(); // DEFAULTS OPTIONS
// console.log(TKAPI.options); IF YOU WANT TO SEE THE CURRENT OPTIONS AND CHANGE IT IF YOU WANT, IT IS A PUBLIC PROPERTY
let gameMarker = TKAPI.options.symbol;
let btnPositionDiv = document.querySelectorAll('.tkGUI-viewer > div');
btnPositionDiv.forEach(el =>{
el.addEventListener('click', ()=>{
let botNum = TKAPI.getResponse(parseInt(el.getAttribute('block-position')));
// IF BOT RETURN FALSE DO NOT DO ANYTHING
// REMMENBER THAT EXIST THE POSITION 0, SO YOU NEED TO BE CAREFULL TO USE if(botNum){} BECAUSE THAT WILL RETURN FALSE WHEN THE BOT RETURN POSITION 0
if(botNum !== false){
// IF THE BOT RETURN A NUMBER MEANS THAT ALL IS GOING WELL AND YOU CAN CONTINUE RUNNING THE PROCESS HERE
el.innerHTML = gameMarker.user;
// REMMENBER THAT EXIST THE -1 STATUS AND MEANS THAT THE BOT STOPPED WORKING BECAUSE SOMEONE WON, AND IS WAITING THE USER FOR RESET
if(botNum >= 0){
btnPositionDiv[botNum].innerHTML = gameMarker.bot;
}
// CHECK THE GAME STATUS WITH class.getWinner();
// FOR SIMPLY UI VIEW IN DEBUG PROCCESS YOU CAN USE THE class.getSimplyUI();
let statusGame = TKAPI.getWinner();
if(statusGame){
// CONSOLE THE STATUS
console.log(statusGame);
}
}
});
});
```
With the main file js you can create your own tik tak toe game code, but if you want to make the game fastly you can use the default GUI extensions
### 1. Include this script after the main script
```html
```
### 2. Create the variable
```javascript
let element = document.getElementById('element'); // The element where the library are going to insert the code
let options = {}; // The options of TkApi
const TKAPIGUI = new TkApiGui(element, options, (statusGame) => { // Do this when someone won the game });
```
### 3. Examples of code
```javascript
let element = document.getElementById('element');
let options = {};
const TKAPIGUI = new TkApiGui(element, options, (statusGame) => {
// PRINT THE STATUS
console.log(statusGame);
});
```
### Love this repo? Give us a star ⭐
