ztimson/hacknet
ztimson/hacknet
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Update README.md

Browse Source
This commit is contained in:
Zakary Timson 2023-12-05 03:12:20 +00:00
parent 80ca3ae777
commit 66a98acd07
1 changed files with 72 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
README.md
View File

@ -1,70 +1,72 @@
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<img src="./src/assets/logo.png" alt="Logo" width="200" height="200">
<!-- Title -->
### Hacknet
<!-- Description -->
Experimental Hacking Game
<!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet/tags&query=$[0].name)](https://git.zakscode.com/ztimson/hacknet/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet&query=open_pr_counter)](https://git.zakscode.com/ztimson/hacknet/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet&query=open_issues_count)](https://git.zakscode.com/ztimson/hacknet/issues)
---
<!-- Links -->
<div>
<a href="https://git.zakscode.com/ztimson/hacknet/releases" target="_blank">Release Notes</a>
• <a href="https://git.zakscode.com/ztimson/hacknet/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
• <a href="https://git.zakscode.com/ztimson/hacknet/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [Hacknet](#top)
- [About](#about)
- [Built With](#built-with)
- [Setup](#setup)
- [Development](#development)
- [License](#license)
## About
Hacknet is an experimental game written in Typescript meant to provide a virtual networked environment one can hack.
The game provides a console and it is up to users to write their own scripts using the provided API to engage with the environment.
### Built With
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
## Setup
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### Instructions
1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start`
3. Open [http://localhost:4200](http://localhost:4200)
</details>
## License
Copyright © 2023 Zakary Timson | All Rights Reserved
See the [license](./LICENSE) for more information.
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<img src="./src/assets/logo.png" alt="Logo" width="200" height="200">
<!-- Title -->
### Hacknet
<!-- Description -->
Experimental Hacking Game
<!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet/tags&query=$[0].name)](https://git.zakscode.com/ztimson/hacknet/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet&query=open_pr_counter)](https://git.zakscode.com/ztimson/hacknet/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet&query=open_issues_count)](https://git.zakscode.com/ztimson/hacknet/issues)
---
<!-- Links -->
<div>
<a href="https://git.zakscode.com/ztimson/hacknet/releases" target="_blank">Release Notes</a>
• <a href="https://git.zakscode.com/ztimson/hacknet/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
• <a href="https://git.zakscode.com/ztimson/hacknet/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [Hacknet](#top)
- [About](#about)
- [Built With](#built-with)
- [Setup](#setup)
- [Development](#development)
- [License](#license)
## About
Hacknet is an experimental game written in Typescript meant to provide a virtual networked environment one can hack.
This project was built using the experminatl [web konsole](https://git.zakscode.com/ztimson/konsole).
The game provides a console and it is up to users to write their own scripts using the provided API to engage with the environment.
### Built With
[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
## Setup
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### Instructions
1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run start`
3. Open [http://localhost:4200](http://localhost:4200)
</details>
## License
Copyright © 2023 Zakary Timson | All Rights Reserved
See the [license](./LICENSE) for more information.