2023-12-01 14:42:10 -05:00
|
|
|
<!-- Header -->
|
|
|
|
<div id="top" align="center">
|
|
|
|
<br />
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
<!-- Logo -->
|
|
|
|
<img src="./src/assets/logo.png" alt="Logo" width="200" height="200">
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
<!-- Title -->
|
|
|
|
### Hacknet
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
<!-- Description -->
|
|
|
|
Experimental Hacking Game
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
<!-- 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)
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
---
|
|
|
|
<!-- 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>
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
---
|
|
|
|
</div>
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
## Table of Contents
|
|
|
|
- [Hacknet](#top)
|
|
|
|
- [About](#about)
|
|
|
|
- [Built With](#built-with)
|
|
|
|
- [Setup](#setup)
|
|
|
|
- [Development](#development)
|
|
|
|
- [License](#license)
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
## About
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
Hacknet is an experimental game written in Typescript meant to provide a virtual networked environment one can hack.
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
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.
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
### 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/)
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
## Setup
|
2023-01-29 08:14:02 -05:00
|
|
|
|
2023-12-01 14:42:10 -05:00
|
|
|
<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.
|