Nyxtext Save

⚠️ The project is actively being developed. Need to add/ rebase a lot of stuff!. \

Nyxtext

Info · Early Access · Showcase · Contribution · Support

 

 

NyxText is a basic text editor built using Python, Tkinter and Custom Tkinter, featuring the elegant Catppuccin color scheme and the minimalist Paperus icon theme. This project represents a collaboration effort, with each element of the text editor organized into separate files for clarity and maintainability.

Join our community!

---

Note :

As the first project developed by a group of undergraduates, NyxNote is a work in progress. We appreciate any contributions, understanding that the project may have bugs, instability, and limited features during the time of active development. Please check back or join our Discord server to see our progress!

NyxText is currently in early access (v0.0.5-α). A downloadable installer will be available in the beta phase.

🧠 Design Philosophy

• Simplicity: Keep the user interface clean and intuitive. Avoid cluttering the interface with unnecessary features or options. Focus on providing essential functionality in an easy-to-use manner.
• Customizability: Provide users with options to customize the editor to suit their preferences.
• Modularity: Design the codebase to be modular and extensible.
• Maintainability: Keep the codebase maintainable and readable.
• Community Engagement: Foster a vibrant and inclusive community around the editor. Encourage users to provide feedback, report bugs, and contribute code.
• Feature Rich: Have all the basic features for a text editor

 

🎨 Palette

Catppuccin consists of 4 beautiful pastel color palettes.
Thats not it it also has some other custom made themes like lumber and H2O.
The number of themes is not definite, we will be adding more in the future, Also you can make your own.

⚠️ Image referenced from Catppuccin's Repo

 

✨Features :

• Edit Text files ~ duh.
• Workspace - Work on multiple text file simultaneously.
• Syntax highlighting - For the code space area.
• Catpuccin Color Palette themes(4) + 4 Custom made themes and counting on..
• Dark / Light mode.
• Basic functions (new,open,save,cut,copy, etc.) check menu bar for more..
• FileTree View which shows all your project's files & folders.
• System scaling support.
• Responsive design - 3 modes (windowed, middleman, fullscreen).
• AI assistence, shortcuts to Gemini, ChatGPT, BlackboxAI...
• Integrated Terminal Supports all basic commands, highly customizable, supports multiple tabs to run simultaneously...
• Integrated Gemini: Includes a powerful search bar powered by the Gemini API for easy access to code and content.
• More Soon...

 

💡Future Plans :

• Complete rebase to custom_tkinter - Done 28/02/2024 ✅
• Integrated Gemini AI - Done 27/04/2024 ✅
• Auto completion, Grammer check
• Filetree viewer - Done 02/03/2024 ✅
• Spell Check
• Syntax Highlighter - Done 09/03/2024 ✅ ~ Used Chlorophyll
• Search & replace
• Split file viewer, comparasion window
• Focus window
• Undo / Redo
• Working Settings page
• Terminal Support - Done ✅ ~ Intergated TkTerm
• Text Formatting - (Bold, Underline, Bulletpoints)
• Basic file Encryption / Decryption
• Hyperlinks, Markdown support
• Auto completion when pressing Tab for Codespace
• Git support
• Running files in a separate terminal or command prompt window
• Automatic indenting and trailing whitespace stripping when Enter is pressed
• Line length marker
• Code folding
• Multiple files can be opened at the same time like tabs in a web browser
• The tabs can be dragged out of the window to open a new window

 

🍷 Early editor screenshots:

 

---

🐜 Bugs :

• It's not responsive as the project is still in early development. - Done 08/03/2024 ✅

• The editor only works in the full screen at the moment. - Done 08/03/2024 ✅ - Now has 3 modes

• Filetree cannot open files

• There is no dynamic heading.

• Search bar does not work.

• Currently the codebase is not modular and contains a lot of redundant code and is not optimized for performance, has two versions. First tkinter based and second custom tkinter based (hybrid).

---

🌟 Early Access :

Run main.py in editor/scipts to start the editor, project is very unstable at the moment and bugs are expected.

How do I run NyxText in the Alpha Phase ? :

Here's a step-by-step guide on getting nyxtext up and running:

1. Install Python:

• If you don't have Python installed, download the appropriate installer for your operating system from the official website: https://www.python.org/downloads/.
• Follow the on-screen instructions to complete the installation.

2. Install Dependencies:

• Open a terminal or command prompt window.
• Install the required Python libraries using pip:

python -m pip install -r requirements.txt

3. Usage:

• Clone the Repository:
• Click the <>code button, clone or download the repo.
• cd to your desired location
• In your terminal, run the following command:

git clone https://github.com/parazeeknova/nyxtext.git

4. Run the Editor:

• Navigate to the checkout directory:

python -u editor/scripts/main.py

This will launch the nyxtext editor.

If you encounter any problems or have any questions while using nyxtext, feel free to reach out to me.

 

⭐ Stargraph:

---

❓ FAQs:

What's new in the latest NyxText release?

See CHANGELOG.md.

Help! NyxtText doesn't work.

Install all the python pip packages for alpha stage. If it still doesn't work, let me know by creating an issue on GitHub.

Is NyxText written in NyxText?

Not at the moment. We are writing the very first version in VSCodium, but will use it when we are done with basic features.

Why is it named NyxText?

1. Mythological Inspiration: NyxText draws upon the Greek goddess Nyx, associated with night, creation, and beginnings. This resonates with writers and programmers who often find inspiration during the quiet hours. The name subtly reflects this theme through its potential use of darker design elements.

2. Euphony and Distinction: NyxText possesses a pleasant sound with Nyx adding a touch of mystique. This name stands out from common text editors, making it both memorable and unique.

3. Symbolic Alignment: Nyx can also symbolize the blank canvas or the void before creation. This perfectly aligns with the core function of a text editor - providing a blank slate for writers and programmers to bring their ideas to life.

I want an editor that does X, but X is not in the feature list above. Does NyxText do X?

You can run NyxText and find out, or create an issue on GitHub and ask. If you manage to make us excited about X, We might implement it.

Why did you create a new editor?

Because I can.

Why did you create a new editor in tkinter or X?

Because I can.

Why not use editor X?

Because NyxText is better.

---

👐 Contributing

[!NOTE]
Thank you for considering contributing to NyxNote! We welcome contributions from everyone, whether you're fixing a bug, adding a feature, or improving documentation.

See CONTRIBUTING.md

 

📜 License

NyxText is released under the MIT license, which grants the following permissions:

• Commercial use
• Distribution
• Modification
• Private use

For more convoluted language, see the LICENSE.

 

💖 Gratitude

Thanks to my Team for the initial development of the project, contributing this project :

• Noviciuss (init Developer)
• Castimonia07 (init Colorschemes)

 

 

Copyright © 2024-present NyxText