Some documentation, scripts and CI

This commit is contained in:
Late Night Defender 2021-11-15 23:00:55 +07:00
parent 26d6b7940e
commit db832eb540
7 changed files with 213 additions and 1 deletions

12
.travis.yml Normal file
View file

@ -0,0 +1,12 @@
language: cpp
compiler: gcc
jobs:
include:
- os: linux
dist: focal
- os: linux
dist: xenial
env:
- BUILD_TYPE=Debug
script:
- echo 1 | ./install.sh

View file

@ -1,2 +1,61 @@
# CursedSnakeGame ![Banner](info/banner.png)
[![PGTechs](https://img.shields.io/static/v1.svg?color=ff0000&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=PG%20Techs&message=YouTube)](https://www.youtube.com/c/PGTechs "ช่อง YouTube ของเรา")
[![PGVCPlus](https://img.shields.io/static/v1.svg?color=0572e6&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=PGVC%2B&message=Facebook)](https://www.facebook.com/PrincegameRVCPlus "เพจข่าวสาร Distributed Computing ของเรา บน Facebook")
อีกหนึ่งแอปพลิเคชันคุณภาพจาก SashaPGT
* ทุกแอปพลิเคชันผ่านการทดสอบติดตั้งและใช้งานใน Test environment ของเรา
* ใช้งานได้อย่างสะดวกรวดเร็ว ด้วยสคริปต์ติดตั้งแบบสำเร็จรูป ทั้งเฉพาะผู้ใช้และ System-wide
* รองรับ Linux ด้วย ไลบรารี (n)curses
# sashapgt/cursedsnakegame
[![Build Status](https://app.travis-ci.com/sashapgt/cursedsnakegame.svg?branch=main)](https://app.travis-ci.com/gitlab/sashapgt/cursedsnakegame)
เกมงูที่เขียนด้วย C++ และ (n)curses มีระเบิดสุ่มเกิดทั่วแมป เสียงเอฟเฟกต์ ประวัติคะแนน และอื่น ๆ
![Screenshot](info/screenshot.png)
# วิธีการติดตั้ง/ใช้งาน
### ติดตั้งแบบปกติ
1. ดาวน์โหลดและติดตั้งแพ็กเกจ Ncurses development libraries (เช่น `ncurses-devel` และ `ncurses-c++-libs` บน Fedora Linux)
2. โคลน git นี้
`$ git clone https://gitlab.com/sashapgt/cursedsnakegame.git`
3. cd เข้าโฟลเดอร์ของ git นี้ แล้วรันสคริปต์ติดตั้ง
`$ cd cursedsnakegame && bash install.sh`
4. เรียกใช้จากเทอร์มินัล (Shell autocomplete อาจจะยังไม่ทำงาน กรุณาปิดเทอร์มินัล แล้วเปิดใหม่อีกครั้ง)
`$ cursedsnakegame`
### ใช้งานครั้งเดียว (Build, run และ remove ทันทีเมื่อใช้งานเสร็จโดยอัตโนมัติ)
$ bash single-use-build-and-run.sh
# ถอนการติดตั้ง
1. รันสคริปต์ถอนการติดตั้งจากในโฟลเดอร์ git นี้
`$ bash uninstall.sh`
2. ลบโฟลเดอร์ git นี้
# การแก้ปัญหา
หากไม่สามารถรันได้เนื่องจาก Command not found ให้ดูว่ามี ~/.local/bin ใน $PATH หรือไม่
สามารถตรวจสอบได้โดยการ
echo $PATH
หากไม่มี Home folder ของคุณ ตามด้วย .local/bin ให้เพิ่มบรรทัดนี้ลงใน Shell startup script ของคุณ (เช่น .bashrc .zshrc)
export PATH="$PATH:$HOME/.local/bin"

BIN
info/banner.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
info/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

60
install.sh Executable file
View file

@ -0,0 +1,60 @@
#!/bin/bash
DIR1=$HOME/.local/bin
DIR2=/usr/local/bin
APPNAME=$(basename $PWD)
clear
if [[ "${EUID}" -eq 0 ]]; then
echo " "
echo "คุณกำลังใช้สิทธิ์ Root! ต้องการดำเนินการติดตั้งต่อใน $DIR2 หรือไม่"
echo " "
echo "1) ไม่"
echo "2) ใช่"
echo " "
read -p "ใส่คำตอบของคุณ [1] : " INSTALLCHOICE
until [[ -z "$INSTALLCHOICE" || "$INSTALLCHOICE" =~ ^[1-2]$ ]]; do
printf "\n$INSTALLCHOICE: ค่าที่ใส่ไม่ถูกต้อง\n\n"
read -p "ใส่คำตอบของคุณ [1] : " INSTALLCHOICE
done
case "$INSTALLCHOICE" in
1|"")
exit
;;
2)
DIR=$DIR2
printf "\nกำลัง Build และติดตั้ง $APPNAME ใน $DIR\n"
g++ -o $APPNAME main.cpp -lncurses && mv $APPNAME $DIR
;;
esac
else
echo " "
echo "เลือกผู้ใช้ที่ต้องการติดตั้งให้"
echo " "
echo "1) $USER ($DIR1)"
echo "2) ทุกคน ($DIR2)"
echo " "
read -p "ใส่คำตอบของคุณ [1] : " INSTALLCHOICE
until [[ -z "$INSTALLCHOICE" || "$INSTALLCHOICE" =~ ^[1-2]$ ]]; do
printf "\n$INSTALLCHOICE: ค่าที่ใส่ไม่ถูกต้อง\n\n"
read -p "ใส่คำตอบของคุณ [1] : " INSTALLCHOICE
done
case "$INSTALLCHOICE" in
1|"")
DIR=$DIR1
if [[ ! -d "$DIR" ]]; then
mkdir -p $DIR
fi
printf "\nกำลัง Build และติดตั้ง $APPNAME ใน $DIR\n"
g++ -o $APPNAME main.cpp -lncurses && mv $APPNAME $DIR
;;
2)
DIR=$DIR2
printf "\nกำลัง Build และติดตั้ง $APPNAME ใน $DIR\n"
printf "\nกรุณาใส่รหัสผ่าน sudo หากถูกถามในการติดตั้ง\n\n"
g++ -o $APPNAME main.cpp && sudo mv $APPNAME $DIR
;;
esac
fi
printf "\nการติดตั้ง $APPNAME ใน $DIR เสร็จสมบูรณ์\n"

7
single-use-build-and-run.sh Executable file
View file

@ -0,0 +1,7 @@
#!/bin/bash
g++ -o main main.cpp -lncurses
./main
rm main

74
uninstall.sh Executable file
View file

@ -0,0 +1,74 @@
#!/bin/bash
DIR1=$HOME/.local/bin
DIR2=/usr/local/bin
APPNAME=$(basename $PWD)
clear
if [[ "${EUID}" -eq 0 ]]; then
echo " "
echo "คุณกำลังใช้สิทธิ์ Root! ต้องการถอนการติดตั้งจาก $DIR2 หรือไม่"
echo " "
echo "1) ไม่"
echo "2) ใช่"
echo " "
read -p "ใส่คำตอบของคุณ [1] : " UNINSTALLCHOICE
until [[ -z "$UNINSTALLCHOICE" || "$UNINSTALLCHOICE" =~ ^[1-2]$ ]]; do
printf "\n$UNINSTALLCHOICE: ค่าที่ใส่ไม่ถูกต้อง\n\n"
read -p "ใส่คำตอบของคุณ [1] : " UNINSTALLCHOICE
done
case "$UNINSTALLCHOICE" in
1|"")
exit
;;
2)
DIR=$DIR2
if [[ -f "$DIR/$APPNAME" ]]; then
echo "กำลังถอนการติดตั้ง $APPNAME จาก $DIR"
rm $DIR/$APPNAME
else
echo "ไม่สามารถถอนการติดตั้งได้เนื่องจากยังไม่ได้ติดตั้งแอปพลิเคชันใน $DIR"
fi
;;
esac
else
echo " "
echo "เลือกผู้ใช้ที่ต้องการถอนติดตั้งให้"
echo " "
echo "1) $USER ($DIR1)"
echo "2) ทุกคน ($DIR2)"
echo " "
read -p "ใส่คำตอบของคุณ : " UNINSTALLCHOICE
until [[ -z "$UNINSTALLCHOICE" || "$UNINSTALLCHOICE" =~ ^[1-2]$ ]]; do
echo "$UNINSTALLCHOICE: ค่าที่ใส่ไม่ถูกต้อง"
read -p "ใส่คำตอบของคุณ :" UNINSTALLCHOICE
done
case "$UNINSTALLCHOICE" in
1)
DIR=$DIR1
if [[ -f "$DIR/$APPNAME" ]]; then
printf "\nกำลังถอนการติดตั้ง $APPNAME จาก $DIR\n"
rm $DIR/$APPNAME
else
printf "\nไม่สามารถถอนการติดตั้งได้เนื่องจากยังไม่ได้ติดตั้งแอปพลิเคชันใน $DIR"
exit
fi
;;
2)
DIR=$DIR2
if [[ -f "$DIR/$APPNAME" ]]; then
printf "\nกำลังถอนการติดตั้ง $APPNAME จาก $DIR\n"
printf "\nกรุณาใส่รหัสผ่าน sudo หากถูกถามขณะถอนการติดตั้ง\n\n"
sudo rm $DIR/$APPNAME
else
printf "\nไม่สามารถถอนการติดตั้งได้เนื่องจากยังไม่ได้ติดตั้งแอปพลิเคชันใน $DIR"
exit
fi
;;
"")
exit
;;
esac
fi
printf "\nการถอนการติดตั้ง $APPNAME จาก $DIR เสร็จสมบูรณ์\n"