Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 4.62 KB

README.md

File metadata and controls

83 lines (60 loc) · 4.62 KB

Octops

An open-source point and click game made in Python 3.11
Made with Kivy and compiled with Nuitka

Hacktoberfest 2023

Introduction · Overview · Local Development · File Structure · Authors

Introduction

Welcome to the open-source project, Octops! In this, we've combined the nostalgia of the original game Counter Strike 1.6 with an exciting new gameplay concept. If you're eager to dive into the action and defuse the bomb, follow this documentation to set up and play the game.

Overview

The game consists of different screens based on Counter Strike 1.6 theme. There's a map which gives access to different locations. Each screen presents players with a distinct challenge or mission. There are hints which can be located on the bomb. To succeed, players must solve puzzles, and apply their skills effectively. Once all the tasks are accomplished, players gain access to the bomb and must defuse it to win the round.

Local Development

To set up the project locally, check out the INSTRUCTIONS.md file and follow the steps mentioned there.

To build the game executable yourself and run it, check out the build/README.md file.

For contributions, check out the CONTRIBUTING.md file and be sure to adhere to the guidelines mentioned there.

File Structure

The project is divided into different folders, each with a specific purpose. Here's a brief overview of the contents of each folder: The project is structured into several folders and files:

1. assets/

The assets/ directory is intended for storing assets such as images, fonts, audio, and other resources that your application may need. These assets can be accessed within your Kivy files.

Example:

  • assets/main_logo.png

2. screen_layout/

The screen_layout/ directory contains the Kivy language (KV) files that define the structure and appearance of the app's screens and their layouts. These KV files are built to their respective screens in the screens/ folder using Builder.load_file().

Example:

  • screen_layout/main_screen.kv
  • screen_layout/map_screen.kv

3. screens/

The screens/ directory is intended for Python files that define the behavior and logic of individual screens within your application. These screens are managed and coordinated using Kivy's ScreenManager in the main Python file.

Example:

  • screens/main_screen.py
  • screens/map_screen.py

4. octops.py

octops.py is the main Python script that acts as the entry point of your Kivy application. It connects and manages all the components of your application, including screens, transitions, and user interactions. This script initializes the Kivy app and sets up the screen manager.

Example:

  • octops.py

Authors

This project is created by MLSA KIIT team members:


MLSAKIIT MLSAKIIT MLSAKIIT MLSAKIIT MLSAKIIT